========================================
Active and Available Inventory REST API.
========================================

.. raw:: html

   <div class="container">

.. rubric:: Active and Available Inventory REST API.
   :name: active-and-available-inventory-rest-api.

Version: v11

| Copyright © 2017 AT&T Intellectual Property. All rights reserved.
| Licensed under the Creative Commons License, Attribution 4.0 Intl.
  (the "License"); you may not use this documentation except in
  compliance with the License.
| You may obtain a copy of the License at
| `(https://creativecommons.org/licenses/by/4.0/) <https://creativecommons.org/licenses/by/4.0>`__
| 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.
| ECOMP and OpenECOMP are trademarks and service marks of AT&T
  Intellectual Property.
| 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.

.. raw:: html

   <div id="sw-schemes" class="sw-default-value">

Schemes: https

.. raw:: html

   </div>

.. rubric:: Summary
   :name: swagger--summary-tags

.. rubric:: Tag: CloudInfrastructure
   :name: tag-CloudInfrastructure
   :class: swagger-summary-tag

+--------------------------------------+--------------------------------------+
| Operation                            | Description                          |
+======================================+======================================+
| `GET                                 | returns cloud-regions                |
| /cloud-infrastructure/cloud-regions  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns cloud-region                 |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id} <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | cloud-region                         |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id} <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing cloud-region      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id} <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns availability-zones           |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--availability-zones-get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns availability-zone            |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones/availabi |                                      |
| lity-zone/{availability-zone-name} < |                                      |
| #operation--cloud-infrastructure-clo |                                      |
| ud-regions-cloud-region--cloud-owner |                                      |
| ---cloud-region-id--availability-zon |                                      |
| es-availability-zone--availability-z |                                      |
| one-name--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | availability-zone                    |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones/availabi |                                      |
| lity-zone/{availability-zone-name} < |                                      |
| #operation--cloud-infrastructure-clo |                                      |
| ud-regions-cloud-region--cloud-owner |                                      |
| ---cloud-region-id--availability-zon |                                      |
| es-availability-zone--availability-z |                                      |
| one-name--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing availability-zone |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones/availabi |                                      |
| lity-zone/{availability-zone-name} < |                                      |
| #operation--cloud-infrastructure-clo |                                      |
| ud-regions-cloud-region--cloud-owner |                                      |
| ---cloud-region-id--availability-zon |                                      |
| es-availability-zone--availability-z |                                      |
| one-name--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones/availabi |                                      |
| lity-zone/{availability-zone-name}/r |                                      |
| elationship-list/relationship <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--availability-zones-av |                                      |
| ailability-zone--availability-zone-n |                                      |
| ame--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/availability-zones/availabi |                                      |
| lity-zone/{availability-zone-name}/r |                                      |
| elationship-list/relationship <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--availability-zones-av |                                      |
| ailability-zone--availability-zone-n |                                      |
| ame--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns dvs-switches                 |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches <#operation--c |                                      |
| loud-infrastructure-cloud-regions-cl |                                      |
| oud-region--cloud-owner---cloud-regi |                                      |
| on-id--dvs-switches-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns dvs-switch                   |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches/dvs-switch/{sw |                                      |
| itch-name} <#operation--cloud-infras |                                      |
| tructure-cloud-regions-cloud-region- |                                      |
| -cloud-owner---cloud-region-id--dvs- |                                      |
| switches-dvs-switch--switch-name--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | dvs-switch                           |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches/dvs-switch/{sw |                                      |
| itch-name} <#operation--cloud-infras |                                      |
| tructure-cloud-regions-cloud-region- |                                      |
| -cloud-owner---cloud-region-id--dvs- |                                      |
| switches-dvs-switch--switch-name--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing dvs-switch        |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches/dvs-switch/{sw |                                      |
| itch-name} <#operation--cloud-infras |                                      |
| tructure-cloud-regions-cloud-region- |                                      |
| -cloud-owner---cloud-region-id--dvs- |                                      |
| switches-dvs-switch--switch-name--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches/dvs-switch/{sw |                                      |
| itch-name}/relationship-list/relatio |                                      |
| nship <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--dvs-switc |                                      |
| hes-dvs-switch--switch-name--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/dvs-switches/dvs-switch/{sw |                                      |
| itch-name}/relationship-list/relatio |                                      |
| nship <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--dvs-switc |                                      |
| hes-dvs-switch--switch-name--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info-list         |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--esr-system-info-list- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info              |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list/esr-sy |                                      |
| stem-info/{esr-system-info-id} <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--esr-system-info-list |                                      |
| -esr-system-info--esr-system-info-id |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | esr-system-info                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list/esr-sy |                                      |
| stem-info/{esr-system-info-id} <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--esr-system-info-list |                                      |
| -esr-system-info--esr-system-info-id |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-system-info   |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list/esr-sy |                                      |
| stem-info/{esr-system-info-id} <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--esr-system-info-list |                                      |
| -esr-system-info--esr-system-info-id |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list/esr-sy |                                      |
| stem-info/{esr-system-info-id}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--cloud-infrastructure-cloud-region |                                      |
| s-cloud-region--cloud-owner---cloud- |                                      |
| region-id--esr-system-info-list-esr- |                                      |
| system-info--esr-system-info-id--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/esr-system-info-list/esr-sy |                                      |
| stem-info/{esr-system-info-id}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--cloud-infrastructure-cloud-region |                                      |
| s-cloud-region--cloud-owner---cloud- |                                      |
| region-id--esr-system-info-list-esr- |                                      |
| system-info--esr-system-info-id--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns flavors                      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors <#operation--cloud- |                                      |
| infrastructure-cloud-regions-cloud-r |                                      |
| egion--cloud-owner---cloud-region-id |                                      |
| --flavors-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns flavor                       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors/flavor/{flavor-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--flavors-flavor- |                                      |
| -flavor-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing flavor  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors/flavor/{flavor-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--flavors-flavor- |                                      |
| -flavor-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing flavor            |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors/flavor/{flavor-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--flavors-flavor- |                                      |
| -flavor-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors/flavor/{flavor-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--flavors-flavor--flav |                                      |
| or-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/flavors/flavor/{flavor-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--flavors-flavor--flav |                                      |
| or-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns group-assignments            |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments <#operati |                                      |
| on--cloud-infrastructure-cloud-regio |                                      |
| ns-cloud-region--cloud-owner---cloud |                                      |
| -region-id--group-assignments-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns group-assignment             |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments/group-ass |                                      |
| ignment/{group-id} <#operation--clou |                                      |
| d-infrastructure-cloud-regions-cloud |                                      |
| -region--cloud-owner---cloud-region- |                                      |
| id--group-assignments-group-assignme |                                      |
| nt--group-id--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | group-assignment                     |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments/group-ass |                                      |
| ignment/{group-id} <#operation--clou |                                      |
| d-infrastructure-cloud-regions-cloud |                                      |
| -region--cloud-owner---cloud-region- |                                      |
| id--group-assignments-group-assignme |                                      |
| nt--group-id--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing group-assignment  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments/group-ass |                                      |
| ignment/{group-id} <#operation--clou |                                      |
| d-infrastructure-cloud-regions-cloud |                                      |
| -region--cloud-owner---cloud-region- |                                      |
| id--group-assignments-group-assignme |                                      |
| nt--group-id--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments/group-ass |                                      |
| ignment/{group-id}/relationship-list |                                      |
| /relationship <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--g |                                      |
| roup-assignments-group-assignment--g |                                      |
| roup-id--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/group-assignments/group-ass |                                      |
| ignment/{group-id}/relationship-list |                                      |
| /relationship <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--g |                                      |
| roup-assignments-group-assignment--g |                                      |
| roup-id--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns images                       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images <#operation--cloud-i |                                      |
| nfrastructure-cloud-regions-cloud-re |                                      |
| gion--cloud-owner---cloud-region-id- |                                      |
| -images-get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns image                        |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id} <#o |                                      |
| peration--cloud-infrastructure-cloud |                                      |
| -regions-cloud-region--cloud-owner-- |                                      |
| -cloud-region-id--images-image--imag |                                      |
| e-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing image   |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id} <#o |                                      |
| peration--cloud-infrastructure-cloud |                                      |
| -regions-cloud-region--cloud-owner-- |                                      |
| -cloud-region-id--images-image--imag |                                      |
| e-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing image             |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id} <#o |                                      |
| peration--cloud-infrastructure-cloud |                                      |
| -regions-cloud-region--cloud-owner-- |                                      |
| -cloud-region-id--images-image--imag |                                      |
| e-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadata                     |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/met |                                      |
| adata <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--images-im |                                      |
| age--image-id--metadata-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadatum                    |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/met |                                      |
| adata/metadatum/{metaname} <#operati |                                      |
| on--cloud-infrastructure-cloud-regio |                                      |
| ns-cloud-region--cloud-owner---cloud |                                      |
| -region-id--images-image--image-id-- |                                      |
| metadata-metadatum--metaname--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | metadatum                            |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/met |                                      |
| adata/metadatum/{metaname} <#operati |                                      |
| on--cloud-infrastructure-cloud-regio |                                      |
| ns-cloud-region--cloud-owner---cloud |                                      |
| -region-id--images-image--image-id-- |                                      |
| metadata-metadatum--metaname--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing metadatum         |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/met |                                      |
| adata/metadatum/{metaname} <#operati |                                      |
| on--cloud-infrastructure-cloud-regio |                                      |
| ns-cloud-region--cloud-owner---cloud |                                      |
| -region-id--images-image--image-id-- |                                      |
| metadata-metadatum--metaname--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--images-image--image-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/images/image/{image-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--images-image--image-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns oam-networks                 |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks <#operation--c |                                      |
| loud-infrastructure-cloud-regions-cl |                                      |
| oud-region--cloud-owner---cloud-regi |                                      |
| on-id--oam-networks-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns oam-network                  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks/oam-network/{n |                                      |
| etwork-uuid} <#operation--cloud-infr |                                      |
| astructure-cloud-regions-cloud-regio |                                      |
| n--cloud-owner---cloud-region-id--oa |                                      |
| m-networks-oam-network--network-uuid |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | oam-network                          |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks/oam-network/{n |                                      |
| etwork-uuid} <#operation--cloud-infr |                                      |
| astructure-cloud-regions-cloud-regio |                                      |
| n--cloud-owner---cloud-region-id--oa |                                      |
| m-networks-oam-network--network-uuid |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing oam-network       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks/oam-network/{n |                                      |
| etwork-uuid} <#operation--cloud-infr |                                      |
| astructure-cloud-regions-cloud-regio |                                      |
| n--cloud-owner---cloud-region-id--oa |                                      |
| m-networks-oam-network--network-uuid |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks/oam-network/{n |                                      |
| etwork-uuid}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-cloud-regions-cloud-region--cl |                                      |
| oud-owner---cloud-region-id--oam-net |                                      |
| works-oam-network--network-uuid--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/oam-networks/oam-network/{n |                                      |
| etwork-uuid}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-cloud-regions-cloud-region--cl |                                      |
| oud-owner---cloud-region-id--oam-net |                                      |
| works-oam-network--network-uuid--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-cloud-regions-cloud-region--cloud- |                                      |
| owner---cloud-region-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-cloud-regions-cloud-region--cloud- |                                      |
| owner---cloud-region-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns snapshots                    |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots <#operation--clou |                                      |
| d-infrastructure-cloud-regions-cloud |                                      |
| -region--cloud-owner---cloud-region- |                                      |
| id--snapshots-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns snapshot                     |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots/snapshot/{snapsho |                                      |
| t-id} <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--snapshots |                                      |
| -snapshot--snapshot-id--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | snapshot                             |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots/snapshot/{snapsho |                                      |
| t-id} <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--snapshots |                                      |
| -snapshot--snapshot-id--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing snapshot          |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots/snapshot/{snapsho |                                      |
| t-id} <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--snapshots |                                      |
| -snapshot--snapshot-id--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots/snapshot/{snapsho |                                      |
| t-id}/relationship-list/relationship |                                      |
|  <#operation--cloud-infrastructure-c |                                      |
| loud-regions-cloud-region--cloud-own |                                      |
| er---cloud-region-id--snapshots-snap |                                      |
| shot--snapshot-id--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/snapshots/snapshot/{snapsho |                                      |
| t-id}/relationship-list/relationship |                                      |
|  <#operation--cloud-infrastructure-c |                                      |
| loud-regions-cloud-region--cloud-own |                                      |
| er---cloud-region-id--snapshots-snap |                                      |
| shot--snapshot-id--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns tenants                      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants <#operation--cloud- |                                      |
| infrastructure-cloud-regions-cloud-r |                                      |
| egion--cloud-owner---cloud-region-id |                                      |
| --tenants-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns tenant                       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing tenant  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing tenant            |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--tenants-tenant--tena |                                      |
| nt-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--tenants-tenant--tena |                                      |
| nt-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vservers                     |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--tenant |                                      |
| s-tenant--tenant-id--vservers-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vserver                      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id} <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--tenants-tenant--tenan |                                      |
| t-id--vservers-vserver--vserver-id-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vserver |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id} <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--tenants-tenant--tenan |                                      |
| t-id--vservers-vserver--vserver-id-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vserver           |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id} <#oper |                                      |
| ation--cloud-infrastructure-cloud-re |                                      |
| gions-cloud-region--cloud-owner---cl |                                      |
| oud-region-id--tenants-tenant--tenan |                                      |
| t-id--vservers-vserver--vserver-id-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces <#operation--cloud-infrastruc |                                      |
| ture-cloud-regions-cloud-region--clo |                                      |
| ud-owner---cloud-region-id--tenants- |                                      |
| tenant--tenant-id--vservers-vserver- |                                      |
| -vserver-id--l-interfaces-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--vservers-vserver--vserve |                                      |
| r-id--l-interfaces-l-interface--inte |                                      |
| rface-name--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | l-interface                          |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--vservers-vserver--vserve |                                      |
| r-id--l-interfaces-l-interface--inte |                                      |
| rface-name--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}  |                                      |
| <#operation--cloud-infrastructure-cl |                                      |
| oud-regions-cloud-region--cloud-owne |                                      |
| r---cloud-region-id--tenants-tenant- |                                      |
| -tenant-id--vservers-vserver--vserve |                                      |
| r-id--l-interfaces-l-interface--inte |                                      |
| rface-name--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv4-address-list/{l3-i |                                      |
| nterface-ipv4-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv4-address-list/{l3-i |                                      |
| nterface-ipv4-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv4-address-list/{l3-i |                                      |
| nterface-ipv4-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv4-address-list/{l3-i |                                      |
| nterface-ipv4-address}/relationship- |                                      |
| list/relationship <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--tenants-tenant--tenant-id--vserve |                                      |
| rs-vserver--vserver-id--l-interfaces |                                      |
| -l-interface--interface-name--l3-int |                                      |
| erface-ipv4-address-list--l3-interfa |                                      |
| ce-ipv4-address--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv4-address-list/{l3-i |                                      |
| nterface-ipv4-address}/relationship- |                                      |
| list/relationship <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--tenants-tenant--tenant-id--vserve |                                      |
| rs-vserver--vserver-id--l-interfaces |                                      |
| -l-interface--interface-name--l3-int |                                      |
| erface-ipv4-address-list--l3-interfa |                                      |
| ce-ipv4-address--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv6-address-list/{l3-i |                                      |
| nterface-ipv6-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv6-address-list/{l3-i |                                      |
| nterface-ipv6-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv6-address-list/{l3-i |                                      |
| nterface-ipv6-address} <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv6-address-list/{l3-i |                                      |
| nterface-ipv6-address}/relationship- |                                      |
| list/relationship <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--tenants-tenant--tenant-id--vserve |                                      |
| rs-vserver--vserver-id--l-interfaces |                                      |
| -l-interface--interface-name--l3-int |                                      |
| erface-ipv6-address-list--l3-interfa |                                      |
| ce-ipv6-address--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| l3-interface-ipv6-address-list/{l3-i |                                      |
| nterface-ipv6-address}/relationship- |                                      |
| list/relationship <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--tenants-tenant--tenant-id--vserve |                                      |
| rs-vserver--vserver-id--l-interfaces |                                      |
| -l-interface--interface-name--l3-int |                                      |
| erface-ipv6-address-list--l3-interfa |                                      |
| ce-ipv6-address--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--tenants-tenant--tena |                                      |
| nt-id--vservers-vserver--vserver-id- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-cloud-r |                                      |
| egions-cloud-region--cloud-owner---c |                                      |
| loud-region-id--tenants-tenant--tena |                                      |
| nt-id--vservers-vserver--vserver-id- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs <#operation--cloud-infrast |                                      |
| ructure-cloud-regions-cloud-region-- |                                      |
| cloud-owner---cloud-region-id--tenan |                                      |
| ts-tenant--tenant-id--vservers-vserv |                                      |
| er--vserver-id--l-interfaces-l-inter |                                      |
| face--interface-name--sriov-vfs-get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs/sriov-vf/{pci-id} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--sriov-vfs-sriov-vf--pci-id--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | sriov-vf                             |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs/sriov-vf/{pci-id} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--sriov-vfs-sriov-vf--pci-id--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs/sriov-vf/{pci-id} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--sriov-vfs-sriov-vf--pci-id--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs/sriov-vf/{pci-id}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--s |                                      |
| riov-vfs-sriov-vf--pci-id--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| sriov-vfs/sriov-vf/{pci-id}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--s |                                      |
| riov-vfs-sriov-vf--pci-id--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans <#operation--cloud-infrastruct |                                      |
| ure-cloud-regions-cloud-region--clou |                                      |
| d-owner---cloud-region-id--tenants-t |                                      |
| enant--tenant-id--vservers-vserver-- |                                      |
| vserver-id--l-interfaces-l-interface |                                      |
| --interface-name--vlans-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface} <#operat |                                      |
| ion--cloud-infrastructure-cloud-regi |                                      |
| ons-cloud-region--cloud-owner---clou |                                      |
| d-region-id--tenants-tenant--tenant- |                                      |
| id--vservers-vserver--vserver-id--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv4-address-list/{l3-interface |                                      |
| -ipv4-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv4 |                                      |
| -address-list--l3-interface-ipv4-add |                                      |
| ress--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv4-address-list/{l3-interface |                                      |
| -ipv4-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv4 |                                      |
| -address-list--l3-interface-ipv4-add |                                      |
| ress--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv4-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv4-address-list/{l3-interface |                                      |
| -ipv4-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv4 |                                      |
| -address-list--l3-interface-ipv4-add |                                      |
| ress--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv4-address-list/{l3-interface |                                      |
| -ipv4-address}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-cloud-regions-cloud-region-- |                                      |
| cloud-owner---cloud-region-id--tenan |                                      |
| ts-tenant--tenant-id--vservers-vserv |                                      |
| er--vserver-id--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--l3-interface-ipv4-addr |                                      |
| ess-list--l3-interface-ipv4-address- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv4-address-list/{l3-interface |                                      |
| -ipv4-address}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-cloud-regions-cloud-region-- |                                      |
| cloud-owner---cloud-region-id--tenan |                                      |
| ts-tenant--tenant-id--vservers-vserv |                                      |
| er--vserver-id--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--l3-interface-ipv4-addr |                                      |
| ess-list--l3-interface-ipv4-address- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv6-address-list/{l3-interface |                                      |
| -ipv6-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv6 |                                      |
| -address-list--l3-interface-ipv6-add |                                      |
| ress--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv6-address-list/{l3-interface |                                      |
| -ipv6-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv6 |                                      |
| -address-list--l3-interface-ipv6-add |                                      |
| ress--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | l3-interface-ipv6-address-list       |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv6-address-list/{l3-interface |                                      |
| -ipv6-address} <#operation--cloud-in |                                      |
| frastructure-cloud-regions-cloud-reg |                                      |
| ion--cloud-owner---cloud-region-id-- |                                      |
| tenants-tenant--tenant-id--vservers- |                                      |
| vserver--vserver-id--l-interfaces-l- |                                      |
| interface--interface-name--vlans-vla |                                      |
| n--vlan-interface--l3-interface-ipv6 |                                      |
| -address-list--l3-interface-ipv6-add |                                      |
| ress--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv6-address-list/{l3-interface |                                      |
| -ipv6-address}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-cloud-regions-cloud-region-- |                                      |
| cloud-owner---cloud-region-id--tenan |                                      |
| ts-tenant--tenant-id--vservers-vserv |                                      |
| er--vserver-id--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--l3-interface-ipv6-addr |                                      |
| ess-list--l3-interface-ipv6-address- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/l3-inter |                                      |
| face-ipv6-address-list/{l3-interface |                                      |
| -ipv6-address}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-cloud-regions-cloud-region-- |                                      |
| cloud-owner---cloud-region-id--tenan |                                      |
| ts-tenant--tenant-id--vservers-vserv |                                      |
| er--vserver-id--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--l3-interface-ipv6-addr |                                      |
| ess-list--l3-interface-ipv6-address- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/l-inte |                                      |
| rfaces/l-interface/{interface-name}/ |                                      |
| vlans/vlan/{vlan-interface}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--tenants-tenant--tenant-id--v |                                      |
| servers-vserver--vserver-id--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --cloud-infrastructure-cloud-regions |                                      |
| -cloud-region--cloud-owner---cloud-r |                                      |
| egion-id--tenants-tenant--tenant-id- |                                      |
| -vservers-vserver--vserver-id--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --cloud-infrastructure-cloud-regions |                                      |
| -cloud-region--cloud-owner---cloud-r |                                      |
| egion-id--tenants-tenant--tenant-id- |                                      |
| -vservers-vserver--vserver-id--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns volumes                      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s <#operation--cloud-infrastructure- |                                      |
| cloud-regions-cloud-region--cloud-ow |                                      |
| ner---cloud-region-id--tenants-tenan |                                      |
| t--tenant-id--vservers-vserver--vser |                                      |
| ver-id--volumes-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns volume                       |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s/volume/{volume-id} <#operation--cl |                                      |
| oud-infrastructure-cloud-regions-clo |                                      |
| ud-region--cloud-owner---cloud-regio |                                      |
| n-id--tenants-tenant--tenant-id--vse |                                      |
| rvers-vserver--vserver-id--volumes-v |                                      |
| olume--volume-id--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing volume  |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s/volume/{volume-id} <#operation--cl |                                      |
| oud-infrastructure-cloud-regions-clo |                                      |
| ud-region--cloud-owner---cloud-regio |                                      |
| n-id--tenants-tenant--tenant-id--vse |                                      |
| rvers-vserver--vserver-id--volumes-v |                                      |
| olume--volume-id--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing volume            |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s/volume/{volume-id} <#operation--cl |                                      |
| oud-infrastructure-cloud-regions-clo |                                      |
| ud-region--cloud-owner---cloud-regio |                                      |
| n-id--tenants-tenant--tenant-id--vse |                                      |
| rvers-vserver--vserver-id--volumes-v |                                      |
| olume--volume-id--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s/volume/{volume-id}/relationship-li |                                      |
| st/relationship <#operation--cloud-i |                                      |
| nfrastructure-cloud-regions-cloud-re |                                      |
| gion--cloud-owner---cloud-region-id- |                                      |
| -tenants-tenant--tenant-id--vservers |                                      |
| -vserver--vserver-id--volumes-volume |                                      |
| --volume-id--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/tenants/tenant/{tenant-id}/ |                                      |
| vservers/vserver/{vserver-id}/volume |                                      |
| s/volume/{volume-id}/relationship-li |                                      |
| st/relationship <#operation--cloud-i |                                      |
| nfrastructure-cloud-regions-cloud-re |                                      |
| gion--cloud-owner---cloud-region-id- |                                      |
| -tenants-tenant--tenant-id--vservers |                                      |
| -vserver--vserver-id--volumes-volume |                                      |
| --volume-id--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vip-ipv4-address-list        |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv4-address-list/{vip- |                                      |
| ipv4-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv4-address-list--vip-ipv4-addre |                                      |
| ss--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | vip-ipv4-address-list                |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv4-address-list/{vip- |                                      |
| ipv4-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv4-address-list--vip-ipv4-addre |                                      |
| ss--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | vip-ipv4-address-list                |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv4-address-list/{vip- |                                      |
| ipv4-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv4-address-list--vip-ipv4-addre |                                      |
| ss--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv4-address-list/{vip- |                                      |
| ipv4-address}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--vip-ip |                                      |
| v4-address-list--vip-ipv4-address--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv4-address-list/{vip- |                                      |
| ipv4-address}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--vip-ip |                                      |
| v4-address-list--vip-ipv4-address--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vip-ipv6-address-list        |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv6-address-list/{vip- |                                      |
| ipv6-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv6-address-list--vip-ipv6-addre |                                      |
| ss--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | vip-ipv6-address-list                |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv6-address-list/{vip- |                                      |
| ipv6-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv6-address-list--vip-ipv6-addre |                                      |
| ss--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/cloud-regions/ | vip-ipv6-address-list                |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv6-address-list/{vip- |                                      |
| ipv6-address} <#operation--cloud-inf |                                      |
| rastructure-cloud-regions-cloud-regi |                                      |
| on--cloud-owner---cloud-region-id--v |                                      |
| ip-ipv6-address-list--vip-ipv6-addre |                                      |
| ss--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv6-address-list/{vip- |                                      |
| ipv6-address}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--vip-ip |                                      |
| v6-address-list--vip-ipv6-address--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/vip-ipv6-address-list/{vip- |                                      |
| ipv6-address}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-cloud-regions-cloud-region--c |                                      |
| loud-owner---cloud-region-id--vip-ip |                                      |
| v6-address-list--vip-ipv6-address--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns volume-groups                |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups <#operation-- |                                      |
| cloud-infrastructure-cloud-regions-c |                                      |
| loud-region--cloud-owner---cloud-reg |                                      |
| ion-id--volume-groups-get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns volume-group                 |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups/volume-group/ |                                      |
| {volume-group-id} <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--volume-groups-volume-group--volum |                                      |
| e-group-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/cloud-regions/ | volume-group                         |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups/volume-group/ |                                      |
| {volume-group-id} <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--volume-groups-volume-group--volum |                                      |
| e-group-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing volume-group      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups/volume-group/ |                                      |
| {volume-group-id} <#operation--cloud |                                      |
| -infrastructure-cloud-regions-cloud- |                                      |
| region--cloud-owner---cloud-region-i |                                      |
| d--volume-groups-volume-group--volum |                                      |
| e-group-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/cloud-regions/ | relationships                        |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups/volume-group/ |                                      |
| {volume-group-id}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-cloud-regions-cloud-regio |                                      |
| n--cloud-owner---cloud-region-id--vo |                                      |
| lume-groups-volume-group--volume-gro |                                      |
| up-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/cloud-regions/ |                                      |
| cloud-region/{cloud-owner}/{cloud-re |                                      |
| gion-id}/volume-groups/volume-group/ |                                      |
| {volume-group-id}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-cloud-regions-cloud-regio |                                      |
| n--cloud-owner---cloud-region-id--vo |                                      |
| lume-groups-volume-group--volume-gro |                                      |
| up-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns complexes                    |
| /cloud-infrastructure/complexes <#op |                                      |
| eration--cloud-infrastructure-comple |                                      |
| xes-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns complex                      |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id} <#operati |                                      |
| on--cloud-infrastructure-complexes-c |                                      |
| omplex--physical-location-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing complex |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id} <#operati |                                      |
| on--cloud-infrastructure-complexes-c |                                      |
| omplex--physical-location-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing complex           |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id} <#operati |                                      |
| on--cloud-infrastructure-complexes-c |                                      |
| omplex--physical-location-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ctag-pools                   |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id}/ctag-pool |                                      |
| s <#operation--cloud-infrastructure- |                                      |
| complexes-complex--physical-location |                                      |
| -id--ctag-pools-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ctag-pool                    |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id}/ctag-pool |                                      |
| s/ctag-pool/{target-pe}/{availabilit |                                      |
| y-zone-name} <#operation--cloud-infr |                                      |
| astructure-complexes-complex--physic |                                      |
| al-location-id--ctag-pools-ctag-pool |                                      |
| --target-pe---availability-zone-name |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/complexes/comp | ctag-pool                            |
| lex/{physical-location-id}/ctag-pool |                                      |
| s/ctag-pool/{target-pe}/{availabilit |                                      |
| y-zone-name} <#operation--cloud-infr |                                      |
| astructure-complexes-complex--physic |                                      |
| al-location-id--ctag-pools-ctag-pool |                                      |
| --target-pe---availability-zone-name |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing ctag-pool         |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id}/ctag-pool |                                      |
| s/ctag-pool/{target-pe}/{availabilit |                                      |
| y-zone-name} <#operation--cloud-infr |                                      |
| astructure-complexes-complex--physic |                                      |
| al-location-id--ctag-pools-ctag-pool |                                      |
| --target-pe---availability-zone-name |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/complexes/comp | relationships                        |
| lex/{physical-location-id}/ctag-pool |                                      |
| s/ctag-pool/{target-pe}/{availabilit |                                      |
| y-zone-name}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-complexes-complex--physical-lo |                                      |
| cation-id--ctag-pools-ctag-pool--tar |                                      |
| get-pe---availability-zone-name--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id}/ctag-pool |                                      |
| s/ctag-pool/{target-pe}/{availabilit |                                      |
| y-zone-name}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-complexes-complex--physical-lo |                                      |
| cation-id--ctag-pools-ctag-pool--tar |                                      |
| get-pe---availability-zone-name--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/complexes/comp | relationships                        |
| lex/{physical-location-id}/relations |                                      |
| hip-list/relationship <#operation--c |                                      |
| loud-infrastructure-complexes-comple |                                      |
| x--physical-location-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/complexes/comp |                                      |
| lex/{physical-location-id}/relations |                                      |
| hip-list/relationship <#operation--c |                                      |
| loud-infrastructure-complexes-comple |                                      |
| x--physical-location-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns network-profiles             |
| /cloud-infrastructure/network-profil |                                      |
| es <#operation--cloud-infrastructure |                                      |
| -network-profiles-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns network-profile              |
| /cloud-infrastructure/network-profil |                                      |
| es/network-profile/{nm-profile-name} |                                      |
|  <#operation--cloud-infrastructure-n |                                      |
| etwork-profiles-network-profile--nm- |                                      |
| profile-name--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/network-profil | network-profile                      |
| es/network-profile/{nm-profile-name} |                                      |
|  <#operation--cloud-infrastructure-n |                                      |
| etwork-profiles-network-profile--nm- |                                      |
| profile-name--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing network-profile   |
| /cloud-infrastructure/network-profil |                                      |
| es/network-profile/{nm-profile-name} |                                      |
|  <#operation--cloud-infrastructure-n |                                      |
| etwork-profiles-network-profile--nm- |                                      |
| profile-name--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/network-profil | relationships                        |
| es/network-profile/{nm-profile-name} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--cloud-infrastructure-networ |                                      |
| k-profiles-network-profile--nm-profi |                                      |
| le-name--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/network-profil |                                      |
| es/network-profile/{nm-profile-name} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--cloud-infrastructure-networ |                                      |
| k-profiles-network-profile--nm-profi |                                      |
| le-name--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns pservers                     |
| /cloud-infrastructure/pservers <#ope |                                      |
| ration--cloud-infrastructure-pserver |                                      |
| s-get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns pserver                      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname} <#operation--cloud-inf |                                      |
| rastructure-pservers-pserver--hostna |                                      |
| me--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing pserver |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname} <#operation--cloud-inf |                                      |
| rastructure-pservers-pserver--hostna |                                      |
| me--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing pserver           |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname} <#operation--cloud-inf |                                      |
| rastructure-pservers-pserver--hostna |                                      |
| me--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interfaces               |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces <#opera |                                      |
| tion--cloud-infrastructure-pservers- |                                      |
| pserver--hostname--lag-interfaces-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interface                |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name} <#operation- |                                      |
| -cloud-infrastructure-pservers-pserv |                                      |
| er--hostname--lag-interfaces-lag-int |                                      |
| erface--interface-name--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | lag-interface                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name} <#operation- |                                      |
| -cloud-infrastructure-pservers-pserv |                                      |
| er--hostname--lag-interfaces-lag-int |                                      |
| erface--interface-name--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing lag-interface     |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name} <#operation- |                                      |
| -cloud-infrastructure-pservers-pserv |                                      |
| er--hostname--lag-interfaces-lag-int |                                      |
| erface--interface-name--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
|  <#operation--cloud-infrastructure-p |                                      |
| servers-pserver--hostname--lag-inter |                                      |
| faces-lag-interface--interface-name- |                                      |
| -l-interfaces-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name} <#oper |                                      |
| ation--cloud-infrastructure-pservers |                                      |
| -pserver--hostname--lag-interfaces-l |                                      |
| ag-interface--interface-name--l-inte |                                      |
| rfaces-l-interface--interface-name-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l-interface                          |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name} <#oper |                                      |
| ation--cloud-infrastructure-pservers |                                      |
| -pserver--hostname--lag-interfaces-l |                                      |
| ag-interface--interface-name--l-inte |                                      |
| rfaces-l-interface--interface-name-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name} <#oper |                                      |
| ation--cloud-infrastructure-pservers |                                      |
| -pserver--hostname--lag-interfaces-l |                                      |
| ag-interface--interface-name--l-inte |                                      |
| rfaces-l-interface--interface-name-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv4-address-list/{l3-interfa |                                      |
| ce-ipv4-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv4-address-list--l3-interface-ipv4 |                                      |
| -address--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv4-address-list/{l3-interfa |                                      |
| ce-ipv4-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv4-address-list--l3-interface-ipv4 |                                      |
| -address--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv4-address-list/{l3-interfa |                                      |
| ce-ipv4-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv4-address-list--l3-interface-ipv4 |                                      |
| -address--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv4-address-list/{l3-interfa |                                      |
| ce-ipv4-address}/relationship-list/r |                                      |
| elationship <#operation--cloud-infra |                                      |
| structure-pservers-pserver--hostname |                                      |
| --lag-interfaces-lag-interface--inte |                                      |
| rface-name--l-interfaces-l-interface |                                      |
| --interface-name--l3-interface-ipv4- |                                      |
| address-list--l3-interface-ipv4-addr |                                      |
| ess--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv4-address-list/{l3-interfa |                                      |
| ce-ipv4-address}/relationship-list/r |                                      |
| elationship <#operation--cloud-infra |                                      |
| structure-pservers-pserver--hostname |                                      |
| --lag-interfaces-lag-interface--inte |                                      |
| rface-name--l-interfaces-l-interface |                                      |
| --interface-name--l3-interface-ipv4- |                                      |
| address-list--l3-interface-ipv4-addr |                                      |
| ess--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv6-address-list/{l3-interfa |                                      |
| ce-ipv6-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv6-address-list--l3-interface-ipv6 |                                      |
| -address--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv6-address-list/{l3-interfa |                                      |
| ce-ipv6-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv6-address-list--l3-interface-ipv6 |                                      |
| -address--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv6-address-list/{l3-interfa |                                      |
| ce-ipv6-address} <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--l3-interface- |                                      |
| ipv6-address-list--l3-interface-ipv6 |                                      |
| -address--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv6-address-list/{l3-interfa |                                      |
| ce-ipv6-address}/relationship-list/r |                                      |
| elationship <#operation--cloud-infra |                                      |
| structure-pservers-pserver--hostname |                                      |
| --lag-interfaces-lag-interface--inte |                                      |
| rface-name--l-interfaces-l-interface |                                      |
| --interface-name--l3-interface-ipv6- |                                      |
| address-list--l3-interface-ipv6-addr |                                      |
| ess--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/l3-int |                                      |
| erface-ipv6-address-list/{l3-interfa |                                      |
| ce-ipv6-address}/relationship-list/r |                                      |
| elationship <#operation--cloud-infra |                                      |
| structure-pservers-pserver--hostname |                                      |
| --lag-interfaces-lag-interface--inte |                                      |
| rface-name--l-interfaces-l-interface |                                      |
| --interface-name--l3-interface-ipv6- |                                      |
| address-list--l3-interface-ipv6-addr |                                      |
| ess--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --cloud-infrastructure-pservers-pser |                                      |
| ver--hostname--lag-interfaces-lag-in |                                      |
| terface--interface-name--l-interface |                                      |
| s-l-interface--interface-name--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --cloud-infrastructure-pservers-pser |                                      |
| ver--hostname--lag-interfaces-lag-in |                                      |
| terface--interface-name--l-interface |                                      |
| s-l-interface--interface-name--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs <#operation--cloud-infrastructur |                                      |
| e-pservers-pserver--hostname--lag-in |                                      |
| terfaces-lag-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--sriov-vfs-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs/sriov-vf/{pci-id} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--sriov-vf |                                      |
| s-sriov-vf--pci-id--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | sriov-vf                             |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs/sriov-vf/{pci-id} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--sriov-vf |                                      |
| s-sriov-vf--pci-id--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs/sriov-vf/{pci-id} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--sriov-vf |                                      |
| s-sriov-vf--pci-id--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs/sriov-vf/{pci-id}/relationship-l |                                      |
| ist/relationship <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--sriov-vfs-sri |                                      |
| ov-vf--pci-id--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/sriov- |                                      |
| vfs/sriov-vf/{pci-id}/relationship-l |                                      |
| ist/relationship <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--sriov-vfs-sri |                                      |
| ov-vf--pci-id--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--lag-interf |                                      |
| aces-lag-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--vlans-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-vl |                                      |
| an--vlan-interface--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-vl |                                      |
| an--vlan-interface--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface} <#operation--c |                                      |
| loud-infrastructure-pservers-pserver |                                      |
| --hostname--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-vl |                                      |
| an--vlan-interface--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv4-address-list/{l3-interface-ipv4- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv4-address-list/{l3-interface-ipv4- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv4-address-list/{l3-interface-ipv4- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv4-address-list/{l3-interface-ipv4- |                                      |
| address}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-pservers-pserver--hostname--lag-in |                                      |
| terfaces-lag-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--vlans-vlan--vlan-interface |                                      |
| --l3-interface-ipv4-address-list--l3 |                                      |
| -interface-ipv4-address--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv4-address-list/{l3-interface-ipv4- |                                      |
| address}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-pservers-pserver--hostname--lag-in |                                      |
| terfaces-lag-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--vlans-vlan--vlan-interface |                                      |
| --l3-interface-ipv4-address-list--l3 |                                      |
| -interface-ipv4-address--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv6-address-list/{l3-interface-ipv6- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv6-address-list/{l3-interface-ipv6- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv6-address-list/{l3-interface-ipv6- |                                      |
| address} <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--l |                                      |
| ag-interfaces-lag-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv6-address-list/{l3-interface-ipv6- |                                      |
| address}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-pservers-pserver--hostname--lag-in |                                      |
| terfaces-lag-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--vlans-vlan--vlan-interface |                                      |
| --l3-interface-ipv6-address-list--l3 |                                      |
| -interface-ipv6-address--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/l3-interface-i |                                      |
| pv6-address-list/{l3-interface-ipv6- |                                      |
| address}/relationship-list/relations |                                      |
| hip <#operation--cloud-infrastructur |                                      |
| e-pservers-pserver--hostname--lag-in |                                      |
| terfaces-lag-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--vlans-vlan--vlan-interface |                                      |
| --l3-interface-ipv6-address-list--l3 |                                      |
| -interface-ipv6-address--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/relationship-l |                                      |
| ist/relationship <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--vlans-vlan--v |                                      |
| lan-interface--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/l-interfaces |                                      |
| /l-interface/{interface-name}/vlans/ |                                      |
| vlan/{vlan-interface}/relationship-l |                                      |
| ist/relationship <#operation--cloud- |                                      |
| infrastructure-pservers-pserver--hos |                                      |
| tname--lag-interfaces-lag-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--vlans-vlan--v |                                      |
| lan-interface--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/relationship |                                      |
| -list/relationship <#operation--clou |                                      |
| d-infrastructure-pservers-pserver--h |                                      |
| ostname--lag-interfaces-lag-interfac |                                      |
| e--interface-name--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/lag-interfaces/lag-int |                                      |
| erface/{interface-name}/relationship |                                      |
| -list/relationship <#operation--clou |                                      |
| d-infrastructure-pservers-pserver--h |                                      |
| ostname--lag-interfaces-lag-interfac |                                      |
| e--interface-name--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interfaces                 |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces <#operati |                                      |
| on--cloud-infrastructure-pservers-ps |                                      |
| erver--hostname--p-interfaces-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interface                  |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name} <#operation--clo |                                      |
| ud-infrastructure-pservers-pserver-- |                                      |
| hostname--p-interfaces-p-interface-- |                                      |
| interface-name--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | p-interface                          |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name} <#operation--clo |                                      |
| ud-infrastructure-pservers-pserver-- |                                      |
| hostname--p-interfaces-p-interface-- |                                      |
| interface-name--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing p-interface       |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name} <#operation--clo |                                      |
| ud-infrastructure-pservers-pserver-- |                                      |
| hostname--p-interfaces-p-interface-- |                                      |
| interface-name--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces <#o |                                      |
| peration--cloud-infrastructure-pserv |                                      |
| ers-pserver--hostname--p-interfaces- |                                      |
| p-interface--interface-name--l-inter |                                      |
| faces-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name} <#operatio |                                      |
| n--cloud-infrastructure-pservers-pse |                                      |
| rver--hostname--p-interfaces-p-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l-interface                          |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name} <#operatio |                                      |
| n--cloud-infrastructure-pservers-pse |                                      |
| rver--hostname--p-interfaces-p-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name} <#operatio |                                      |
| n--cloud-infrastructure-pservers-pse |                                      |
| rver--hostname--p-interfaces-p-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv4-address-list/{l3-interface-i |                                      |
| pv4-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv4-add |                                      |
| ress-list--l3-interface-ipv4-address |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv4-address-list/{l3-interface-i |                                      |
| pv4-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv4-add |                                      |
| ress-list--l3-interface-ipv4-address |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv4-address-list/{l3-interface-i |                                      |
| pv4-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv4-add |                                      |
| ress-list--l3-interface-ipv4-address |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv4-address-list/{l3-interface-i |                                      |
| pv4-address}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-pservers-pserver--hostname--p- |                                      |
| interfaces-p-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--l3-interface-ipv4-address- |                                      |
| list--l3-interface-ipv4-address--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv4-address-list/{l3-interface-i |                                      |
| pv4-address}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-pservers-pserver--hostname--p- |                                      |
| interfaces-p-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--l3-interface-ipv4-address- |                                      |
| list--l3-interface-ipv4-address--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv6-address-list/{l3-interface-i |                                      |
| pv6-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv6-add |                                      |
| ress-list--l3-interface-ipv6-address |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv6-address-list/{l3-interface-i |                                      |
| pv6-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv6-add |                                      |
| ress-list--l3-interface-ipv6-address |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv6-address-list/{l3-interface-i |                                      |
| pv6-address} <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--l3-interface-ipv6-add |                                      |
| ress-list--l3-interface-ipv6-address |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv6-address-list/{l3-interface-i |                                      |
| pv6-address}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-pservers-pserver--hostname--p- |                                      |
| interfaces-p-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--l3-interface-ipv6-address- |                                      |
| list--l3-interface-ipv6-address--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/l3-interfa |                                      |
| ce-ipv6-address-list/{l3-interface-i |                                      |
| pv6-address}/relationship-list/relat |                                      |
| ionship <#operation--cloud-infrastru |                                      |
| cture-pservers-pserver--hostname--p- |                                      |
| interfaces-p-interface--interface-na |                                      |
| me--l-interfaces-l-interface--interf |                                      |
| ace-name--l3-interface-ipv6-address- |                                      |
| list--l3-interface-ipv6-address--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/relationsh |                                      |
| ip-list/relationship <#operation--cl |                                      |
| oud-infrastructure-pservers-pserver- |                                      |
| -hostname--p-interfaces-p-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--relationship- |                                      |
| list-relationship-put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/relationsh |                                      |
| ip-list/relationship <#operation--cl |                                      |
| oud-infrastructure-pservers-pserver- |                                      |
| -hostname--p-interfaces-p-interface- |                                      |
| -interface-name--l-interfaces-l-inte |                                      |
| rface--interface-name--relationship- |                                      |
| list-relationship-delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--p-interfac |                                      |
| es-p-interface--interface-name--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --sriov-vfs-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs/ |                                      |
| sriov-vf/{pci-id} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--sriov-vfs-sriov- |                                      |
| vf--pci-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | sriov-vf                             |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs/ |                                      |
| sriov-vf/{pci-id} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--sriov-vfs-sriov- |                                      |
| vf--pci-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs/ |                                      |
| sriov-vf/{pci-id} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--sriov-vfs-sriov- |                                      |
| vf--pci-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs/ |                                      |
| sriov-vf/{pci-id}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--sriov-vfs-sriov-vf--p |                                      |
| ci-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/sriov-vfs/ |                                      |
| sriov-vf/{pci-id}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--sriov-vfs-sriov-vf--p |                                      |
| ci-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans <#op |                                      |
| eration--cloud-infrastructure-pserve |                                      |
| rs-pserver--hostname--p-interfaces-p |                                      |
| -interface--interface-name--l-interf |                                      |
| aces-l-interface--interface-name--vl |                                      |
| ans-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--vlans-vlan--vlan |                                      |
| -interface--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--vlans-vlan--vlan |                                      |
| -interface--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface} <#operation--cloud |                                      |
| -infrastructure-pservers-pserver--ho |                                      |
| stname--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--vlans-vlan--vlan |                                      |
| -interface--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv4- |                                      |
| address-list/{l3-interface-ipv4-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv4- |                                      |
| address-list/{l3-interface-ipv4-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv4-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv4- |                                      |
| address-list/{l3-interface-ipv4-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv4-address-list--l3-in |                                      |
| terface-ipv4-address--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv4- |                                      |
| address-list/{l3-interface-ipv4-addr |                                      |
| ess}/relationship-list/relationship  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--p-interfac |                                      |
| es-p-interface--interface-name--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --vlans-vlan--vlan-interface--l3-int |                                      |
| erface-ipv4-address-list--l3-interfa |                                      |
| ce-ipv4-address--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv4- |                                      |
| address-list/{l3-interface-ipv4-addr |                                      |
| ess}/relationship-list/relationship  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--p-interfac |                                      |
| es-p-interface--interface-name--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --vlans-vlan--vlan-interface--l3-int |                                      |
| erface-ipv4-address-list--l3-interfa |                                      |
| ce-ipv4-address--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv6- |                                      |
| address-list/{l3-interface-ipv6-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv6- |                                      |
| address-list/{l3-interface-ipv6-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/pservers/pserv | l3-interface-ipv6-address-list       |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv6- |                                      |
| address-list/{l3-interface-ipv6-addr |                                      |
| ess} <#operation--cloud-infrastructu |                                      |
| re-pservers-pserver--hostname--p-int |                                      |
| erfaces-p-interface--interface-name- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--l |                                      |
| 3-interface-ipv6-address-list--l3-in |                                      |
| terface-ipv6-address--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv6- |                                      |
| address-list/{l3-interface-ipv6-addr |                                      |
| ess}/relationship-list/relationship  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--p-interfac |                                      |
| es-p-interface--interface-name--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --vlans-vlan--vlan-interface--l3-int |                                      |
| erface-ipv6-address-list--l3-interfa |                                      |
| ce-ipv6-address--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/l3-interface-ipv6- |                                      |
| address-list/{l3-interface-ipv6-addr |                                      |
| ess}/relationship-list/relationship  |                                      |
| <#operation--cloud-infrastructure-ps |                                      |
| ervers-pserver--hostname--p-interfac |                                      |
| es-p-interface--interface-name--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --vlans-vlan--vlan-interface--l3-int |                                      |
| erface-ipv6-address-list--l3-interfa |                                      |
| ce-ipv6-address--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/l-interfaces/l-i |                                      |
| nterface/{interface-name}/vlans/vlan |                                      |
| /{vlan-interface}/relationship-list/ |                                      |
| relationship <#operation--cloud-infr |                                      |
| astructure-pservers-pserver--hostnam |                                      |
| e--p-interfaces-p-interface--interfa |                                      |
| ce-name--l-interfaces-l-interface--i |                                      |
| nterface-name--vlans-vlan--vlan-inte |                                      |
| rface--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/relationship-lis |                                      |
| t/relationship <#operation--cloud-in |                                      |
| frastructure-pservers-pserver--hostn |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/relationship-lis |                                      |
| t/relationship <#operation--cloud-in |                                      |
| frastructure-pservers-pserver--hostn |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pfs                    |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs <#oper |                                      |
| ation--cloud-infrastructure-pservers |                                      |
| -pserver--hostname--p-interfaces-p-i |                                      |
| nterface--interface-name--sriov-pfs- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pf                     |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs/sriov- |                                      |
| pf/{pf-pci-id} <#operation--cloud-in |                                      |
| frastructure-pservers-pserver--hostn |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--sriov-pfs-sriov-pf--pf-pc |                                      |
| i-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/pservers/pserv | sriov-pf                             |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs/sriov- |                                      |
| pf/{pf-pci-id} <#operation--cloud-in |                                      |
| frastructure-pservers-pserver--hostn |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--sriov-pfs-sriov-pf--pf-pc |                                      |
| i-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-pf          |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs/sriov- |                                      |
| pf/{pf-pci-id} <#operation--cloud-in |                                      |
| frastructure-pservers-pserver--hostn |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--sriov-pfs-sriov-pf--pf-pc |                                      |
| i-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs/sriov- |                                      |
| pf/{pf-pci-id}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-pservers-pserver--hostname-- |                                      |
| p-interfaces-p-interface--interface- |                                      |
| name--sriov-pfs-sriov-pf--pf-pci-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/p-interfaces/p-interfa |                                      |
| ce/{interface-name}/sriov-pfs/sriov- |                                      |
| pf/{pf-pci-id}/relationship-list/rel |                                      |
| ationship <#operation--cloud-infrast |                                      |
| ructure-pservers-pserver--hostname-- |                                      |
| p-interfaces-p-interface--interface- |                                      |
| name--sriov-pfs-sriov-pf--pf-pci-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/pservers/pserv | relationships                        |
| er/{hostname}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/pservers/pserv |                                      |
| er/{hostname}/relationship-list/rela |                                      |
| tionship <#operation--cloud-infrastr |                                      |
| ucture-pservers-pserver--hostname--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns virtual-data-centers         |
| /cloud-infrastructure/virtual-data-c |                                      |
| enters <#operation--cloud-infrastruc |                                      |
| ture-virtual-data-centers-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns virtual-data-center          |
| /cloud-infrastructure/virtual-data-c |                                      |
| enters/virtual-data-center/{vdc-id}  |                                      |
| <#operation--cloud-infrastructure-vi |                                      |
| rtual-data-centers-virtual-data-cent |                                      |
| er--vdc-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /cloud-infrastructure/virtual-data-c | virtual-data-center                  |
| enters/virtual-data-center/{vdc-id}  |                                      |
| <#operation--cloud-infrastructure-vi |                                      |
| rtual-data-centers-virtual-data-cent |                                      |
| er--vdc-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /cloud-infrastructure/virtual-data-c | virtual-data-center                  |
| enters/virtual-data-center/{vdc-id}  |                                      |
| <#operation--cloud-infrastructure-vi |                                      |
| rtual-data-centers-virtual-data-cent |                                      |
| er--vdc-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /cloud-infrastructure/virtual-data-c | relationships                        |
| enters/virtual-data-center/{vdc-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-virtual |                                      |
| -data-centers-virtual-data-center--v |                                      |
| dc-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /cloud-infrastructure/virtual-data-c |                                      |
| enters/virtual-data-center/{vdc-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--cloud-infrastructure-virtual |                                      |
| -data-centers-virtual-data-center--v |                                      |
| dc-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+

.. rubric:: Tag: ExternalSystem
   :name: tag-ExternalSystem
   :class: swagger-summary-tag

+--------------------------------------+--------------------------------------+
| Operation                            | Description                          |
+======================================+======================================+
| `GET                                 | returns esr-ems-list                 |
| /external-system/esr-ems-list <#oper |                                      |
| ation--external-system-esr-ems-list- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-ems                      |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id} <#operation--external-sys |                                      |
| tem-esr-ems-list-esr-ems--ems-id--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing esr-ems |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id} <#operation--external-sys |                                      |
| tem-esr-ems-list-esr-ems--ems-id--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-ems           |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id} <#operation--external-sys |                                      |
| tem-esr-ems-list-esr-ems--ems-id--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info-list         |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id}/esr-system-info-list <#op |                                      |
| eration--external-system-esr-ems-lis |                                      |
| t-esr-ems--ems-id--esr-system-info-l |                                      |
| ist-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info              |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-ems-li |                                      |
| st-esr-ems--ems-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /external-system/esr-ems-list/esr-em | esr-system-info                      |
| s/{ems-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-ems-li |                                      |
| st-esr-ems--ems-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-system-info   |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-ems-li |                                      |
| st-esr-ems--ems-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-ems-list/esr-em | relationships                        |
| s/{ems-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--external-system-esr-ems-list-es |                                      |
| r-ems--ems-id--esr-system-info-list- |                                      |
| esr-system-info--esr-system-info-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--external-system-esr-ems-list-es |                                      |
| r-ems--ems-id--esr-system-info-list- |                                      |
| esr-system-info--esr-system-info-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-ems-list/esr-em | relationships                        |
| s/{ems-id}/relationship-list/relatio |                                      |
| nship <#operation--external-system-e |                                      |
| sr-ems-list-esr-ems--ems-id--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-ems-list/esr-em |                                      |
| s/{ems-id}/relationship-list/relatio |                                      |
| nship <#operation--external-system-e |                                      |
| sr-ems-list-esr-ems--ems-id--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-thirdparty-sdnc-list     |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list <#operation--external-system-e |                                      |
| sr-thirdparty-sdnc-list-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-thirdparty-sdnc          |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id} <#operation--external-sys |                                      |
| tem-esr-thirdparty-sdnc-list-esr-thi |                                      |
| rdparty-sdnc--thirdparty-sdnc-id--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /external-system/esr-thirdparty-sdnc | esr-thirdparty-sdnc                  |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id} <#operation--external-sys |                                      |
| tem-esr-thirdparty-sdnc-list-esr-thi |                                      |
| rdparty-sdnc--thirdparty-sdnc-id--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /external-system/esr-thirdparty-sdnc | esr-thirdparty-sdnc                  |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id} <#operation--external-sys |                                      |
| tem-esr-thirdparty-sdnc-list-esr-thi |                                      |
| rdparty-sdnc--thirdparty-sdnc-id--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info-list         |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list <#op |                                      |
| eration--external-system-esr-thirdpa |                                      |
| rty-sdnc-list-esr-thirdparty-sdnc--t |                                      |
| hirdparty-sdnc-id--esr-system-info-l |                                      |
| ist-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info              |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-thirdp |                                      |
| arty-sdnc-list-esr-thirdparty-sdnc-- |                                      |
| thirdparty-sdnc-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /external-system/esr-thirdparty-sdnc | esr-system-info                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-thirdp |                                      |
| arty-sdnc-list-esr-thirdparty-sdnc-- |                                      |
| thirdparty-sdnc-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-system-info   |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id} <#o |                                      |
| peration--external-system-esr-thirdp |                                      |
| arty-sdnc-list-esr-thirdparty-sdnc-- |                                      |
| thirdparty-sdnc-id--esr-system-info- |                                      |
| list-esr-system-info--esr-system-inf |                                      |
| o-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-thirdparty-sdnc | relationships                        |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--external-system-esr-thirdparty- |                                      |
| sdnc-list-esr-thirdparty-sdnc--third |                                      |
| party-sdnc-id--esr-system-info-list- |                                      |
| esr-system-info--esr-system-info-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/esr-system-info-list/esr- |                                      |
| system-info/{esr-system-info-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--external-system-esr-thirdparty- |                                      |
| sdnc-list-esr-thirdparty-sdnc--third |                                      |
| party-sdnc-id--esr-system-info-list- |                                      |
| esr-system-info--esr-system-info-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-thirdparty-sdnc | relationships                        |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/relationship-list/relatio |                                      |
| nship <#operation--external-system-e |                                      |
| sr-thirdparty-sdnc-list-esr-thirdpar |                                      |
| ty-sdnc--thirdparty-sdnc-id--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-thirdparty-sdnc |                                      |
| -list/esr-thirdparty-sdnc/{thirdpart |                                      |
| y-sdnc-id}/relationship-list/relatio |                                      |
| nship <#operation--external-system-e |                                      |
| sr-thirdparty-sdnc-list-esr-thirdpar |                                      |
| ty-sdnc--thirdparty-sdnc-id--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-vnfm-list                |
| /external-system/esr-vnfm-list <#ope |                                      |
| ration--external-system-esr-vnfm-lis |                                      |
| t-get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-vnfm                     |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id} <#operation--external- |                                      |
| system-esr-vnfm-list-esr-vnfm--vnfm- |                                      |
| id--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /external-system/esr-vnfm-list/esr-v | esr-vnfm                             |
| nfm/{vnfm-id} <#operation--external- |                                      |
| system-esr-vnfm-list-esr-vnfm--vnfm- |                                      |
| id--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-vnfm          |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id} <#operation--external- |                                      |
| system-esr-vnfm-list-esr-vnfm--vnfm- |                                      |
| id--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info-list         |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id}/esr-system-info-list < |                                      |
| #operation--external-system-esr-vnfm |                                      |
| -list-esr-vnfm--vnfm-id--esr-system- |                                      |
| info-list-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns esr-system-info              |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id}/esr-system-info-list/e |                                      |
| sr-system-info/{esr-system-info-id}  |                                      |
| <#operation--external-system-esr-vnf |                                      |
| m-list-esr-vnfm--vnfm-id--esr-system |                                      |
| -info-list-esr-system-info--esr-syst |                                      |
| em-info-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /external-system/esr-vnfm-list/esr-v | esr-system-info                      |
| nfm/{vnfm-id}/esr-system-info-list/e |                                      |
| sr-system-info/{esr-system-info-id}  |                                      |
| <#operation--external-system-esr-vnf |                                      |
| m-list-esr-vnfm--vnfm-id--esr-system |                                      |
| -info-list-esr-system-info--esr-syst |                                      |
| em-info-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing esr-system-info   |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id}/esr-system-info-list/e |                                      |
| sr-system-info/{esr-system-info-id}  |                                      |
| <#operation--external-system-esr-vnf |                                      |
| m-list-esr-vnfm--vnfm-id--esr-system |                                      |
| -info-list-esr-system-info--esr-syst |                                      |
| em-info-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-vnfm-list/esr-v | relationships                        |
| nfm/{vnfm-id}/esr-system-info-list/e |                                      |
| sr-system-info/{esr-system-info-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--external-system-esr-vnfm-lis |                                      |
| t-esr-vnfm--vnfm-id--esr-system-info |                                      |
| -list-esr-system-info--esr-system-in |                                      |
| fo-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id}/esr-system-info-list/e |                                      |
| sr-system-info/{esr-system-info-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--external-system-esr-vnfm-lis |                                      |
| t-esr-vnfm--vnfm-id--esr-system-info |                                      |
| -list-esr-system-info--esr-system-in |                                      |
| fo-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /external-system/esr-vnfm-list/esr-v | relationships                        |
| nfm/{vnfm-id}/relationship-list/rela |                                      |
| tionship <#operation--external-syste |                                      |
| m-esr-vnfm-list-esr-vnfm--vnfm-id--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /external-system/esr-vnfm-list/esr-v |                                      |
| nfm/{vnfm-id}/relationship-list/rela |                                      |
| tionship <#operation--external-syste |                                      |
| m-esr-vnfm-list-esr-vnfm--vnfm-id--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+

.. rubric:: Tag: Business
   :name: tag-Business
   :class: swagger-summary-tag

+--------------------------------------+--------------------------------------+
| Operation                            | Description                          |
+======================================+======================================+
| `GET                                 | returns connectors                   |
| /business/connectors <#operation--bu |                                      |
| siness-connectors-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns connector                    |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id} <#operation--busin |                                      |
| ess-connectors-connector--resource-i |                                      |
| nstance-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/connectors/connector/{reso | connector                            |
| urce-instance-id} <#operation--busin |                                      |
| ess-connectors-connector--resource-i |                                      |
| nstance-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing connector         |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id} <#operation--busin |                                      |
| ess-connectors-connector--resource-i |                                      |
| nstance-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadata                     |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id}/metadata <#operati |                                      |
| on--business-connectors-connector--r |                                      |
| esource-instance-id--metadata-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadatum                    |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id}/metadata/metadatum |                                      |
| /{metaname} <#operation--business-co |                                      |
| nnectors-connector--resource-instanc |                                      |
| e-id--metadata-metadatum--metaname-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/connectors/connector/{reso | metadatum                            |
| urce-instance-id}/metadata/metadatum |                                      |
| /{metaname} <#operation--business-co |                                      |
| nnectors-connector--resource-instanc |                                      |
| e-id--metadata-metadatum--metaname-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing metadatum         |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id}/metadata/metadatum |                                      |
| /{metaname} <#operation--business-co |                                      |
| nnectors-connector--resource-instanc |                                      |
| e-id--metadata-metadatum--metaname-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/connectors/connector/{reso | relationships                        |
| urce-instance-id}/relationship-list/ |                                      |
| relationship <#operation--business-c |                                      |
| onnectors-connector--resource-instan |                                      |
| ce-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/connectors/connector/{reso |                                      |
| urce-instance-id}/relationship-list/ |                                      |
| relationship <#operation--business-c |                                      |
| onnectors-connector--resource-instan |                                      |
| ce-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns customers                    |
| /business/customers <#operation--bus |                                      |
| iness-customers-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns customer                     |
| /business/customers/customer/{global |                                      |
| -customer-id} <#operation--business- |                                      |
| customers-customer--global-customer- |                                      |
| id--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | customer                             |
| -customer-id} <#operation--business- |                                      |
| customers-customer--global-customer- |                                      |
| id--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing customer          |
| /business/customers/customer/{global |                                      |
| -customer-id} <#operation--business- |                                      |
| customers-customer--global-customer- |                                      |
| id--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/customers/customer/{global | relationships                        |
| -customer-id}/relationship-list/rela |                                      |
| tionship <#operation--business-custo |                                      |
| mers-customer--global-customer-id--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/customers/customer/{global |                                      |
| -customer-id}/relationship-list/rela |                                      |
| tionship <#operation--business-custo |                                      |
| mers-customer--global-customer-id--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-subscriptions        |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions  |                                      |
| <#operation--business-customers-cust |                                      |
| omer--global-customer-id--service-su |                                      |
| bscriptions-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-subscription         |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}  |                                      |
| <#operation--business-customers-cust |                                      |
| omer--global-customer-id--service-su |                                      |
| bscriptions-service-subscription--se |                                      |
| rvice-type--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | service-subscription                 |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}  |                                      |
| <#operation--business-customers-cust |                                      |
| omer--global-customer-id--service-su |                                      |
| bscriptions-service-subscription--se |                                      |
| rvice-type--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /business/customers/customer/{global | service-subscription                 |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}  |                                      |
| <#operation--business-customers-cust |                                      |
| omer--global-customer-id--service-su |                                      |
| bscriptions-service-subscription--se |                                      |
| rvice-type--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/customers/customer/{global | relationships                        |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--business-customers-customer- |                                      |
| -global-customer-id--service-subscri |                                      |
| ptions-service-subscription--service |                                      |
| -type--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--business-customers-customer- |                                      |
| -global-customer-id--service-subscri |                                      |
| ptions-service-subscription--service |                                      |
| -type--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-instances            |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances <#operation--busin |                                      |
| ess-customers-customer--global-custo |                                      |
| mer-id--service-subscriptions-servic |                                      |
| e-subscription--service-type--servic |                                      |
| e-instances-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-instance             |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id} <#operation--bu |                                      |
| siness-customers-customer--global-cu |                                      |
| stomer-id--service-subscriptions-ser |                                      |
| vice-subscription--service-type--ser |                                      |
| vice-instances-service-instance--ser |                                      |
| vice-instance-id--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | service-instance                     |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id} <#operation--bu |                                      |
| siness-customers-customer--global-cu |                                      |
| stomer-id--service-subscriptions-ser |                                      |
| vice-subscription--service-type--ser |                                      |
| vice-instances-service-instance--ser |                                      |
| vice-instance-id--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing service-instance  |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id} <#operation--bu |                                      |
| siness-customers-customer--global-cu |                                      |
| stomer-id--service-subscriptions-ser |                                      |
| vice-subscription--service-type--ser |                                      |
| vice-instances-service-instance--ser |                                      |
| vice-instance-id--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns allotted-resources           |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces <#operation--business-customers- |                                      |
| customer--global-customer-id--servic |                                      |
| e-subscriptions-service-subscription |                                      |
| --service-type--service-instances-se |                                      |
| rvice-instance--service-instance-id- |                                      |
| -allotted-resources-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns allotted-resource            |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id} <#operati |                                      |
| on--business-customers-customer--glo |                                      |
| bal-customer-id--service-subscriptio |                                      |
| ns-service-subscription--service-typ |                                      |
| e--service-instances-service-instanc |                                      |
| e--service-instance-id--allotted-res |                                      |
| ources-allotted-resource--id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | allotted-resource                    |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id} <#operati |                                      |
| on--business-customers-customer--glo |                                      |
| bal-customer-id--service-subscriptio |                                      |
| ns-service-subscription--service-typ |                                      |
| e--service-instances-service-instanc |                                      |
| e--service-instance-id--allotted-res |                                      |
| ources-allotted-resource--id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing allotted-resource |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id} <#operati |                                      |
| on--business-customers-customer--glo |                                      |
| bal-customer-id--service-subscriptio |                                      |
| ns-service-subscription--service-typ |                                      |
| e--service-instances-service-instanc |                                      |
| e--service-instance-id--allotted-res |                                      |
| ources-allotted-resource--id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/customers/customer/{global | relationships                        |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/relations |                                      |
| hip-list/relationship <#operation--b |                                      |
| usiness-customers-customer--global-c |                                      |
| ustomer-id--service-subscriptions-se |                                      |
| rvice-subscription--service-type--se |                                      |
| rvice-instances-service-instance--se |                                      |
| rvice-instance-id--allotted-resource |                                      |
| s-allotted-resource--id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/relations |                                      |
| hip-list/relationship <#operation--b |                                      |
| usiness-customers-customer--global-c |                                      |
| ustomer-id--service-subscriptions-se |                                      |
| rvice-subscription--service-type--se |                                      |
| rvice-instances-service-instance--se |                                      |
| rvice-instance-id--allotted-resource |                                      |
| s-allotted-resource--id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns tunnel-xconnects             |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects <#operation--business-custom |                                      |
| ers-customer--global-customer-id--se |                                      |
| rvice-subscriptions-service-subscrip |                                      |
| tion--service-type--service-instance |                                      |
| s-service-instance--service-instance |                                      |
| -id--allotted-resources-allotted-res |                                      |
| ource--id--tunnel-xconnects-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns tunnel-xconnect              |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects/tunnel-xconnect/{id} <#opera |                                      |
| tion--business-customers-customer--g |                                      |
| lobal-customer-id--service-subscript |                                      |
| ions-service-subscription--service-t |                                      |
| ype--service-instances-service-insta |                                      |
| nce--service-instance-id--allotted-r |                                      |
| esources-allotted-resource--id--tunn |                                      |
| el-xconnects-tunnel-xconnect--id--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | tunnel-xconnect                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects/tunnel-xconnect/{id} <#opera |                                      |
| tion--business-customers-customer--g |                                      |
| lobal-customer-id--service-subscript |                                      |
| ions-service-subscription--service-t |                                      |
| ype--service-instances-service-insta |                                      |
| nce--service-instance-id--allotted-r |                                      |
| esources-allotted-resource--id--tunn |                                      |
| el-xconnects-tunnel-xconnect--id--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing tunnel-xconnect   |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects/tunnel-xconnect/{id} <#opera |                                      |
| tion--business-customers-customer--g |                                      |
| lobal-customer-id--service-subscript |                                      |
| ions-service-subscription--service-t |                                      |
| ype--service-instances-service-insta |                                      |
| nce--service-instance-id--allotted-r |                                      |
| esources-allotted-resource--id--tunn |                                      |
| el-xconnects-tunnel-xconnect--id--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/customers/customer/{global | relationships                        |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects/tunnel-xconnect/{id}/relatio |                                      |
| nship-list/relationship <#operation- |                                      |
| -business-customers-customer--global |                                      |
| -customer-id--service-subscriptions- |                                      |
| service-subscription--service-type-- |                                      |
| service-instances-service-instance-- |                                      |
| service-instance-id--allotted-resour |                                      |
| ces-allotted-resource--id--tunnel-xc |                                      |
| onnects-tunnel-xconnect--id--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/allotted-resour |                                      |
| ces/allotted-resource/{id}/tunnel-xc |                                      |
| onnects/tunnel-xconnect/{id}/relatio |                                      |
| nship-list/relationship <#operation- |                                      |
| -business-customers-customer--global |                                      |
| -customer-id--service-subscriptions- |                                      |
| service-subscription--service-type-- |                                      |
| service-instances-service-instance-- |                                      |
| service-instance-id--allotted-resour |                                      |
| ces-allotted-resource--id--tunnel-xc |                                      |
| onnects-tunnel-xconnect--id--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadata                     |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/metadata <#oper |                                      |
| ation--business-customers-customer-- |                                      |
| global-customer-id--service-subscrip |                                      |
| tions-service-subscription--service- |                                      |
| type--service-instances-service-inst |                                      |
| ance--service-instance-id--metadata- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadatum                    |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/metadata/metada |                                      |
| tum/{metaname} <#operation--business |                                      |
| -customers-customer--global-customer |                                      |
| -id--service-subscriptions-service-s |                                      |
| ubscription--service-type--service-i |                                      |
| nstances-service-instance--service-i |                                      |
| nstance-id--metadata-metadatum--meta |                                      |
| name--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/customers/customer/{global | metadatum                            |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/metadata/metada |                                      |
| tum/{metaname} <#operation--business |                                      |
| -customers-customer--global-customer |                                      |
| -id--service-subscriptions-service-s |                                      |
| ubscription--service-type--service-i |                                      |
| nstances-service-instance--service-i |                                      |
| nstance-id--metadata-metadatum--meta |                                      |
| name--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing metadatum         |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/metadata/metada |                                      |
| tum/{metaname} <#operation--business |                                      |
| -customers-customer--global-customer |                                      |
| -id--service-subscriptions-service-s |                                      |
| ubscription--service-type--service-i |                                      |
| nstances-service-instance--service-i |                                      |
| nstance-id--metadata-metadatum--meta |                                      |
| name--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/customers/customer/{global | relationships                        |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/relationship-li |                                      |
| st/relationship <#operation--busines |                                      |
| s-customers-customer--global-custome |                                      |
| r-id--service-subscriptions-service- |                                      |
| subscription--service-type--service- |                                      |
| instances-service-instance--service- |                                      |
| instance-id--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/customers/customer/{global |                                      |
| -customer-id}/service-subscriptions/ |                                      |
| service-subscription/{service-type}/ |                                      |
| service-instances/service-instance/{ |                                      |
| service-instance-id}/relationship-li |                                      |
| st/relationship <#operation--busines |                                      |
| s-customers-customer--global-custome |                                      |
| r-id--service-subscriptions-service- |                                      |
| subscription--service-type--service- |                                      |
| instances-service-instance--service- |                                      |
| instance-id--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lines-of-business            |
| /business/lines-of-business <#operat |                                      |
| ion--business-lines-of-business-get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns line-of-business             |
| /business/lines-of-business/line-of- |                                      |
| business/{line-of-business-name} <#o |                                      |
| peration--business-lines-of-business |                                      |
| -line-of-business--line-of-business- |                                      |
| name--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/lines-of-business/line-of- | line-of-business                     |
| business/{line-of-business-name} <#o |                                      |
| peration--business-lines-of-business |                                      |
| -line-of-business--line-of-business- |                                      |
| name--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing line-of-business  |
| /business/lines-of-business/line-of- |                                      |
| business/{line-of-business-name} <#o |                                      |
| peration--business-lines-of-business |                                      |
| -line-of-business--line-of-business- |                                      |
| name--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/lines-of-business/line-of- | relationships                        |
| business/{line-of-business-name}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--business-lines-of-business-line |                                      |
| -of-business--line-of-business-name- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/lines-of-business/line-of- |                                      |
| business/{line-of-business-name}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--business-lines-of-business-line |                                      |
| -of-business--line-of-business-name- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns owning-entities              |
| /business/owning-entities <#operatio |                                      |
| n--business-owning-entities-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns owning-entity                |
| /business/owning-entities/owning-ent |                                      |
| ity/{owning-entity-id} <#operation-- |                                      |
| business-owning-entities-owning-enti |                                      |
| ty--owning-entity-id--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/owning-entities/owning-ent | owning-entity                        |
| ity/{owning-entity-id} <#operation-- |                                      |
| business-owning-entities-owning-enti |                                      |
| ty--owning-entity-id--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing owning-entity     |
| /business/owning-entities/owning-ent |                                      |
| ity/{owning-entity-id} <#operation-- |                                      |
| business-owning-entities-owning-enti |                                      |
| ty--owning-entity-id--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/owning-entities/owning-ent | relationships                        |
| ity/{owning-entity-id}/relationship- |                                      |
| list/relationship <#operation--busin |                                      |
| ess-owning-entities-owning-entity--o |                                      |
| wning-entity-id--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/owning-entities/owning-ent |                                      |
| ity/{owning-entity-id}/relationship- |                                      |
| list/relationship <#operation--busin |                                      |
| ess-owning-entities-owning-entity--o |                                      |
| wning-entity-id--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns platforms                    |
| /business/platforms <#operation--bus |                                      |
| iness-platforms-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns platform                     |
| /business/platforms/platform/{platfo |                                      |
| rm-name} <#operation--business-platf |                                      |
| orms-platform--platform-name--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /business/platforms/platform/{platfo | platform                             |
| rm-name} <#operation--business-platf |                                      |
| orms-platform--platform-name--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing platform          |
| /business/platforms/platform/{platfo |                                      |
| rm-name} <#operation--business-platf |                                      |
| orms-platform--platform-name--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/platforms/platform/{platfo | relationships                        |
| rm-name}/relationship-list/relations |                                      |
| hip <#operation--business-platforms- |                                      |
| platform--platform-name--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/platforms/platform/{platfo |                                      |
| rm-name}/relationship-list/relations |                                      |
| hip <#operation--business-platforms- |                                      |
| platform--platform-name--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns projects                     |
| /business/projects <#operation--busi |                                      |
| ness-projects-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns project                      |
| /business/projects/project/{project- |                                      |
| name} <#operation--business-projects |                                      |
| -project--project-name--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing project |
| /business/projects/project/{project- |                                      |
| name} <#operation--business-projects |                                      |
| -project--project-name--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing project           |
| /business/projects/project/{project- |                                      |
| name} <#operation--business-projects |                                      |
| -project--project-name--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /business/projects/project/{project- | relationships                        |
| name}/relationship-list/relationship |                                      |
|  <#operation--business-projects-proj |                                      |
| ect--project-name--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /business/projects/project/{project- |                                      |
| name}/relationship-list/relationship |                                      |
|  <#operation--business-projects-proj |                                      |
| ect--project-name--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+

.. rubric:: Tag: ServiceDesignAndCreation
   :name: tag-ServiceDesignAndCreation
   :class: swagger-summary-tag

+--------------------------------------+--------------------------------------+
| Operation                            | Description                          |
+======================================+======================================+
| `GET                                 | returns models                       |
| /service-design-and-creation/models  |                                      |
| <#operation--service-design-and-crea |                                      |
| tion-models-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model                        |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id} <#operati |                                      |
| on--service-design-and-creation-mode |                                      |
| ls-model--model-invariant-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing model   |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id} <#operati |                                      |
| on--service-design-and-creation-mode |                                      |
| ls-model--model-invariant-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing model             |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id} <#operati |                                      |
| on--service-design-and-creation-mode |                                      |
| ls-model--model-invariant-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-vers                   |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s <#operation--service-design-and-cr |                                      |
| eation-models-model--model-invariant |                                      |
| -id--model-vers-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-ver                    |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| models-model--model-invariant-id--mo |                                      |
| del-vers-model-ver--model-version-id |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | model-ver                            |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| models-model--model-invariant-id--mo |                                      |
| del-vers-model-ver--model-version-id |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing model-ver         |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| models-model--model-invariant-id--mo |                                      |
| del-vers-model-ver--model-version-id |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadata                     |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/metad |                                      |
| ata <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--metadata-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns metadatum                    |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/metad |                                      |
| ata/metadatum/{metaname} <#operation |                                      |
| --service-design-and-creation-models |                                      |
| -model--model-invariant-id--model-ve |                                      |
| rs-model-ver--model-version-id--meta |                                      |
| data-metadatum--metaname--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | metadatum                            |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/metad |                                      |
| ata/metadatum/{metaname} <#operation |                                      |
| --service-design-and-creation-models |                                      |
| -model--model-invariant-id--model-ve |                                      |
| rs-model-ver--model-version-id--meta |                                      |
| data-metadatum--metaname--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing metadatum         |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/metad |                                      |
| ata/metadatum/{metaname} <#operation |                                      |
| --service-design-and-creation-models |                                      |
| -model--model-invariant-id--model-ve |                                      |
| rs-model-ver--model-version-id--meta |                                      |
| data-metadatum--metaname--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-elements               |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements <#operation--service-desig |                                      |
| n-and-creation-models-model--model-i |                                      |
| nvariant-id--model-vers-model-ver--m |                                      |
| odel-version-id--model-elements-get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-element                |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid} <#operation--service-design |                                      |
| -and-creation-models-model--model-in |                                      |
| variant-id--model-vers-model-ver--mo |                                      |
| del-version-id--model-elements-model |                                      |
| -element--model-element-uuid--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | model-element                        |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid} <#operation--service-design |                                      |
| -and-creation-models-model--model-in |                                      |
| variant-id--model-vers-model-ver--mo |                                      |
| del-version-id--model-elements-model |                                      |
| -element--model-element-uuid--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing model-element     |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid} <#operation--service-design |                                      |
| -and-creation-models-model--model-in |                                      |
| variant-id--model-vers-model-ver--mo |                                      |
| del-version-id--model-elements-model |                                      |
| -element--model-element-uuid--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-constraints            |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints <#operati |                                      |
| on--service-design-and-creation-mode |                                      |
| ls-model--model-invariant-id--model- |                                      |
| vers-model-ver--model-version-id--mo |                                      |
| del-elements-model-element--model-el |                                      |
| ement-uuid--model-constraints-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns model-constraint             |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid} <#op |                                      |
| eration--service-design-and-creation |                                      |
| -models-model--model-invariant-id--m |                                      |
| odel-vers-model-ver--model-version-i |                                      |
| d--model-elements-model-element--mod |                                      |
| el-element-uuid--model-constraints-m |                                      |
| odel-constraint--model-constraint-uu |                                      |
| id--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | model-constraint                     |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid} <#op |                                      |
| eration--service-design-and-creation |                                      |
| -models-model--model-invariant-id--m |                                      |
| odel-vers-model-ver--model-version-i |                                      |
| d--model-elements-model-element--mod |                                      |
| el-element-uuid--model-constraints-m |                                      |
| odel-constraint--model-constraint-uu |                                      |
| id--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing model-constraint  |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid} <#op |                                      |
| eration--service-design-and-creation |                                      |
| -models-model--model-invariant-id--m |                                      |
| odel-vers-model-ver--model-version-i |                                      |
| d--model-elements-model-element--mod |                                      |
| el-element-uuid--model-constraints-m |                                      |
| odel-constraint--model-constraint-uu |                                      |
| id--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns constrained-element-sets     |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets <#operation--se |                                      |
| rvice-design-and-creation-models-mod |                                      |
| el--model-invariant-id--model-vers-m |                                      |
| odel-ver--model-version-id--model-el |                                      |
| ements-model-element--model-element- |                                      |
| uuid--model-constraints-model-constr |                                      |
| aint--model-constraint-uuid--constra |                                      |
| ined-element-sets-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns constrained-element-set      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id} <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--model-elements-model-elem |                                      |
| ent--model-element-uuid--model-const |                                      |
| raints-model-constraint--model-const |                                      |
| raint-uuid--constrained-element-sets |                                      |
| -constrained-element-set--constraine |                                      |
| d-element-set-uuid--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | constrained-element-set              |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id} <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--model-elements-model-elem |                                      |
| ent--model-element-uuid--model-const |                                      |
| raints-model-constraint--model-const |                                      |
| raint-uuid--constrained-element-sets |                                      |
| -constrained-element-set--constraine |                                      |
| d-element-set-uuid--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /service-design-and-creation/models/ | constrained-element-set              |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id} <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--model-elements-model-elem |                                      |
| ent--model-element-uuid--model-const |                                      |
| raints-model-constraint--model-const |                                      |
| raint-uuid--constrained-element-sets |                                      |
| -constrained-element-set--constraine |                                      |
| d-element-set-uuid--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns element-choice-sets          |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets <#operation- |                                      |
| -service-design-and-creation-models- |                                      |
| model--model-invariant-id--model-ver |                                      |
| s-model-ver--model-version-id--model |                                      |
| -elements-model-element--model-eleme |                                      |
| nt-uuid--model-constraints-model-con |                                      |
| straint--model-constraint-uuid--cons |                                      |
| trained-element-sets-constrained-ele |                                      |
| ment-set--constrained-element-set-uu |                                      |
| id--element-choice-sets-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns element-choice-set           |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets/element-choi |                                      |
| ce-set/{element-choice-set-uuid} <#o |                                      |
| peration--service-design-and-creatio |                                      |
| n-models-model--model-invariant-id-- |                                      |
| model-vers-model-ver--model-version- |                                      |
| id--model-elements-model-element--mo |                                      |
| del-element-uuid--model-constraints- |                                      |
| model-constraint--model-constraint-u |                                      |
| uid--constrained-element-sets-constr |                                      |
| ained-element-set--constrained-eleme |                                      |
| nt-set-uuid--element-choice-sets-ele |                                      |
| ment-choice-set--element-choice-set- |                                      |
| uuid--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/models/ | element-choice-set                   |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets/element-choi |                                      |
| ce-set/{element-choice-set-uuid} <#o |                                      |
| peration--service-design-and-creatio |                                      |
| n-models-model--model-invariant-id-- |                                      |
| model-vers-model-ver--model-version- |                                      |
| id--model-elements-model-element--mo |                                      |
| del-element-uuid--model-constraints- |                                      |
| model-constraint--model-constraint-u |                                      |
| uid--constrained-element-sets-constr |                                      |
| ained-element-set--constrained-eleme |                                      |
| nt-set-uuid--element-choice-sets-ele |                                      |
| ment-choice-set--element-choice-set- |                                      |
| uuid--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /service-design-and-creation/models/ | element-choice-set                   |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets/element-choi |                                      |
| ce-set/{element-choice-set-uuid} <#o |                                      |
| peration--service-design-and-creatio |                                      |
| n-models-model--model-invariant-id-- |                                      |
| model-vers-model-ver--model-version- |                                      |
| id--model-elements-model-element--mo |                                      |
| del-element-uuid--model-constraints- |                                      |
| model-constraint--model-constraint-u |                                      |
| uid--constrained-element-sets-constr |                                      |
| ained-element-set--constrained-eleme |                                      |
| nt-set-uuid--element-choice-sets-ele |                                      |
| ment-choice-set--element-choice-set- |                                      |
| uuid--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/models/ | relationships                        |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets/element-choi |                                      |
| ce-set/{element-choice-set-uuid}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--service-design-and-creation-mod |                                      |
| els-model--model-invariant-id--model |                                      |
| -vers-model-ver--model-version-id--m |                                      |
| odel-elements-model-element--model-e |                                      |
| lement-uuid--model-constraints-model |                                      |
| -constraint--model-constraint-uuid-- |                                      |
| constrained-element-sets-constrained |                                      |
| -element-set--constrained-element-se |                                      |
| t-uuid--element-choice-sets-element- |                                      |
| choice-set--element-choice-set-uuid- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/element-choice-sets/element-choi |                                      |
| ce-set/{element-choice-set-uuid}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--service-design-and-creation-mod |                                      |
| els-model--model-invariant-id--model |                                      |
| -vers-model-ver--model-version-id--m |                                      |
| odel-elements-model-element--model-e |                                      |
| lement-uuid--model-constraints-model |                                      |
| -constraint--model-constraint-uuid-- |                                      |
| constrained-element-sets-constrained |                                      |
| -element-set--constrained-element-se |                                      |
| t-uuid--element-choice-sets-element- |                                      |
| choice-set--element-choice-set-uuid- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/models/ | relationships                        |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/relationship-list/relationship < |                                      |
| #operation--service-design-and-creat |                                      |
| ion-models-model--model-invariant-id |                                      |
| --model-vers-model-ver--model-versio |                                      |
| n-id--model-elements-model-element-- |                                      |
| model-element-uuid--model-constraint |                                      |
| s-model-constraint--model-constraint |                                      |
| -uuid--constrained-element-sets-cons |                                      |
| trained-element-set--constrained-ele |                                      |
| ment-set-uuid--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/model-constraints/model-con |                                      |
| straint/{model-constraint-uuid}/cons |                                      |
| trained-element-sets/constrained-ele |                                      |
| ment-set/{constrained-element-set-uu |                                      |
| id}/relationship-list/relationship < |                                      |
| #operation--service-design-and-creat |                                      |
| ion-models-model--model-invariant-id |                                      |
| --model-vers-model-ver--model-versio |                                      |
| n-id--model-elements-model-element-- |                                      |
| model-element-uuid--model-constraint |                                      |
| s-model-constraint--model-constraint |                                      |
| -uuid--constrained-element-sets-cons |                                      |
| trained-element-set--constrained-ele |                                      |
| ment-set-uuid--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/models/ | relationships                        |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/relationship-list/relations |                                      |
| hip <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--model-elements-model-elem |                                      |
| ent--model-element-uuid--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/model |                                      |
| -elements/model-element/{model-eleme |                                      |
| nt-uuid}/relationship-list/relations |                                      |
| hip <#operation--service-design-and- |                                      |
| creation-models-model--model-invaria |                                      |
| nt-id--model-vers-model-ver--model-v |                                      |
| ersion-id--model-elements-model-elem |                                      |
| ent--model-element-uuid--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/models/ | relationships                        |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--service-design-and-creation-model |                                      |
| s-model--model-invariant-id--model-v |                                      |
| ers-model-ver--model-version-id--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/model-ver |                                      |
| s/model-ver/{model-version-id}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--service-design-and-creation-model |                                      |
| s-model--model-invariant-id--model-v |                                      |
| ers-model-ver--model-version-id--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/models/ | relationships                        |
| model/{model-invariant-id}/relations |                                      |
| hip-list/relationship <#operation--s |                                      |
| ervice-design-and-creation-models-mo |                                      |
| del--model-invariant-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/models/ |                                      |
| model/{model-invariant-id}/relations |                                      |
| hip-list/relationship <#operation--s |                                      |
| ervice-design-and-creation-models-mo |                                      |
| del--model-invariant-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns named-queries                |
| /service-design-and-creation/named-q |                                      |
| ueries <#operation--service-design-a |                                      |
| nd-creation-named-queries-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns named-query                  |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| } <#operation--service-design-and-cr |                                      |
| eation-named-queries-named-query--na |                                      |
| med-query-uuid--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/named-q | named-query                          |
| ueries/named-query/{named-query-uuid |                                      |
| } <#operation--service-design-and-cr |                                      |
| eation-named-queries-named-query--na |                                      |
| med-query-uuid--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing named-query       |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| } <#operation--service-design-and-cr |                                      |
| eation-named-queries-named-query--na |                                      |
| med-query-uuid--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns named-query-elements         |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements <#operation-- |                                      |
| service-design-and-creation-named-qu |                                      |
| eries-named-query--named-query-uuid- |                                      |
| -named-query-elements-get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns named-query-element          |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid} <# |                                      |
| operation--service-design-and-creati |                                      |
| on-named-queries-named-query--named- |                                      |
| query-uuid--named-query-elements-nam |                                      |
| ed-query-element--named-query-elemen |                                      |
| t-uuid--get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/named-q | named-query-element                  |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid} <# |                                      |
| operation--service-design-and-creati |                                      |
| on-named-queries-named-query--named- |                                      |
| query-uuid--named-query-elements-nam |                                      |
| ed-query-element--named-query-elemen |                                      |
| t-uuid--put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /service-design-and-creation/named-q | named-query-element                  |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid} <# |                                      |
| operation--service-design-and-creati |                                      |
| on-named-queries-named-query--named- |                                      |
| query-uuid--named-query-elements-nam |                                      |
| ed-query-element--named-query-elemen |                                      |
| t-uuid--delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns property-constraints         |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/pr |                                      |
| operty-constraints <#operation--serv |                                      |
| ice-design-and-creation-named-querie |                                      |
| s-named-query--named-query-uuid--nam |                                      |
| ed-query-elements-named-query-elemen |                                      |
| t--named-query-element-uuid--propert |                                      |
| y-constraints-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns property-constraint          |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/pr |                                      |
| operty-constraints/property-constrai |                                      |
| nt/{property-constraint-uuid} <#oper |                                      |
| ation--service-design-and-creation-n |                                      |
| amed-queries-named-query--named-quer |                                      |
| y-uuid--named-query-elements-named-q |                                      |
| uery-element--named-query-element-uu |                                      |
| id--property-constraints-property-co |                                      |
| nstraint--property-constraint-uuid-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/named-q | property-constraint                  |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/pr |                                      |
| operty-constraints/property-constrai |                                      |
| nt/{property-constraint-uuid} <#oper |                                      |
| ation--service-design-and-creation-n |                                      |
| amed-queries-named-query--named-quer |                                      |
| y-uuid--named-query-elements-named-q |                                      |
| uery-element--named-query-element-uu |                                      |
| id--property-constraints-property-co |                                      |
| nstraint--property-constraint-uuid-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /service-design-and-creation/named-q | property-constraint                  |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/pr |                                      |
| operty-constraints/property-constrai |                                      |
| nt/{property-constraint-uuid} <#oper |                                      |
| ation--service-design-and-creation-n |                                      |
| amed-queries-named-query--named-quer |                                      |
| y-uuid--named-query-elements-named-q |                                      |
| uery-element--named-query-element-uu |                                      |
| id--property-constraints-property-co |                                      |
| nstraint--property-constraint-uuid-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns related-lookups              |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups <#operation--service-d |                                      |
| esign-and-creation-named-queries-nam |                                      |
| ed-query--named-query-uuid--named-qu |                                      |
| ery-elements-named-query-element--na |                                      |
| med-query-element-uuid--related-look |                                      |
| ups-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns related-lookup               |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups/related-lookup/{relate |                                      |
| d-lookup-uuid} <#operation--service- |                                      |
| design-and-creation-named-queries-na |                                      |
| med-query--named-query-uuid--named-q |                                      |
| uery-elements-named-query-element--n |                                      |
| amed-query-element-uuid--related-loo |                                      |
| kups-related-lookup--related-lookup- |                                      |
| uuid--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/named-q | related-lookup                       |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups/related-lookup/{relate |                                      |
| d-lookup-uuid} <#operation--service- |                                      |
| design-and-creation-named-queries-na |                                      |
| med-query--named-query-uuid--named-q |                                      |
| uery-elements-named-query-element--n |                                      |
| amed-query-element-uuid--related-loo |                                      |
| kups-related-lookup--related-lookup- |                                      |
| uuid--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing related-lookup    |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups/related-lookup/{relate |                                      |
| d-lookup-uuid} <#operation--service- |                                      |
| design-and-creation-named-queries-na |                                      |
| med-query--named-query-uuid--named-q |                                      |
| uery-elements-named-query-element--n |                                      |
| amed-query-element-uuid--related-loo |                                      |
| kups-related-lookup--related-lookup- |                                      |
| uuid--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/named-q | relationships                        |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups/related-lookup/{relate |                                      |
| d-lookup-uuid}/relationship-list/rel |                                      |
| ationship <#operation--service-desig |                                      |
| n-and-creation-named-queries-named-q |                                      |
| uery--named-query-uuid--named-query- |                                      |
| elements-named-query-element--named- |                                      |
| query-element-uuid--related-lookups- |                                      |
| related-lookup--related-lookup-uuid- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lated-lookups/related-lookup/{relate |                                      |
| d-lookup-uuid}/relationship-list/rel |                                      |
| ationship <#operation--service-desig |                                      |
| n-and-creation-named-queries-named-q |                                      |
| uery--named-query-uuid--named-query- |                                      |
| elements-named-query-element--named- |                                      |
| query-element-uuid--related-lookups- |                                      |
| related-lookup--related-lookup-uuid- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/named-q | relationships                        |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--service-design-and-creation-na |                                      |
| med-queries-named-query--named-query |                                      |
| -uuid--named-query-elements-named-qu |                                      |
| ery-element--named-query-element-uui |                                      |
| d--relationship-list-relationship-pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/named-query-elements/named-query-e |                                      |
| lement/{named-query-element-uuid}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--service-design-and-creation-na |                                      |
| med-queries-named-query--named-query |                                      |
| -uuid--named-query-elements-named-qu |                                      |
| ery-element--named-query-element-uui |                                      |
| d--relationship-list-relationship-de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/named-q | relationships                        |
| ueries/named-query/{named-query-uuid |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--service-design-and-creatio |                                      |
| n-named-queries-named-query--named-q |                                      |
| uery-uuid--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/named-q |                                      |
| ueries/named-query/{named-query-uuid |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--service-design-and-creatio |                                      |
| n-named-queries-named-query--named-q |                                      |
| uery-uuid--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-capabilities         |
| /service-design-and-creation/service |                                      |
| -capabilities <#operation--service-d |                                      |
| esign-and-creation-service-capabilit |                                      |
| ies-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service-capability           |
| /service-design-and-creation/service |                                      |
| -capabilities/service-capability/{se |                                      |
| rvice-type}/{vnf-type} <#operation-- |                                      |
| service-design-and-creation-service- |                                      |
| capabilities-service-capability--ser |                                      |
| vice-type---vnf-type--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/service | service-capability                   |
| -capabilities/service-capability/{se |                                      |
| rvice-type}/{vnf-type} <#operation-- |                                      |
| service-design-and-creation-service- |                                      |
| capabilities-service-capability--ser |                                      |
| vice-type---vnf-type--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /service-design-and-creation/service | service-capability                   |
| -capabilities/service-capability/{se |                                      |
| rvice-type}/{vnf-type} <#operation-- |                                      |
| service-design-and-creation-service- |                                      |
| capabilities-service-capability--ser |                                      |
| vice-type---vnf-type--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/service | relationships                        |
| -capabilities/service-capability/{se |                                      |
| rvice-type}/{vnf-type}/relationship- |                                      |
| list/relationship <#operation--servi |                                      |
| ce-design-and-creation-service-capab |                                      |
| ilities-service-capability--service- |                                      |
| type---vnf-type--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/service |                                      |
| -capabilities/service-capability/{se |                                      |
| rvice-type}/{vnf-type}/relationship- |                                      |
| list/relationship <#operation--servi |                                      |
| ce-design-and-creation-service-capab |                                      |
| ilities-service-capability--service- |                                      |
| type---vnf-type--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns services                     |
| /service-design-and-creation/service |                                      |
| s <#operation--service-design-and-cr |                                      |
| eation-services-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns service                      |
| /service-design-and-creation/service |                                      |
| s/service/{service-id} <#operation-- |                                      |
| service-design-and-creation-services |                                      |
| -service--service-id--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing service |
| /service-design-and-creation/service |                                      |
| s/service/{service-id} <#operation-- |                                      |
| service-design-and-creation-services |                                      |
| -service--service-id--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing service           |
| /service-design-and-creation/service |                                      |
| s/service/{service-id} <#operation-- |                                      |
| service-design-and-creation-services |                                      |
| -service--service-id--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/service | relationships                        |
| s/service/{service-id}/relationship- |                                      |
| list/relationship <#operation--servi |                                      |
| ce-design-and-creation-services-serv |                                      |
| ice--service-id--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/service |                                      |
| s/service/{service-id}/relationship- |                                      |
| list/relationship <#operation--servi |                                      |
| ce-design-and-creation-services-serv |                                      |
| ice--service-id--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vnf-images                   |
| /service-design-and-creation/vnf-ima |                                      |
| ges <#operation--service-design-and- |                                      |
| creation-vnf-images-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vnf-image                    |
| /service-design-and-creation/vnf-ima |                                      |
| ges/vnf-image/{vnf-image-uuid} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| vnf-images-vnf-image--vnf-image-uuid |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /service-design-and-creation/vnf-ima | vnf-image                            |
| ges/vnf-image/{vnf-image-uuid} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| vnf-images-vnf-image--vnf-image-uuid |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vnf-image         |
| /service-design-and-creation/vnf-ima |                                      |
| ges/vnf-image/{vnf-image-uuid} <#ope |                                      |
| ration--service-design-and-creation- |                                      |
| vnf-images-vnf-image--vnf-image-uuid |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /service-design-and-creation/vnf-ima | relationships                        |
| ges/vnf-image/{vnf-image-uuid}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--service-design-and-creation-vnf-i |                                      |
| mages-vnf-image--vnf-image-uuid--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /service-design-and-creation/vnf-ima |                                      |
| ges/vnf-image/{vnf-image-uuid}/relat |                                      |
| ionship-list/relationship <#operatio |                                      |
| n--service-design-and-creation-vnf-i |                                      |
| mages-vnf-image--vnf-image-uuid--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+

.. rubric:: Tag: Network
   :name: tag-Network
   :class: swagger-summary-tag

+--------------------------------------+--------------------------------------+
| Operation                            | Description                          |
+======================================+======================================+
| `GET                                 | returns generic-vnfs                 |
| /network/generic-vnfs <#operation--n |                                      |
| etwork-generic-vnfs-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns generic-vnf                  |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | generic-vnf                          |
| nf-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing generic-vnf       |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns entitlements                 |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/entitlements <#operation--net |                                      |
| work-generic-vnfs-generic-vnf--vnf-i |                                      |
| d--entitlements-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns entitlement                  |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/entitlements/entitlement/{gro |                                      |
| up-uuid}/{resource-uuid} <#operation |                                      |
| --network-generic-vnfs-generic-vnf-- |                                      |
| vnf-id--entitlements-entitlement--gr |                                      |
| oup-uuid---resource-uuid--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | entitlement                          |
| nf-id}/entitlements/entitlement/{gro |                                      |
| up-uuid}/{resource-uuid} <#operation |                                      |
| --network-generic-vnfs-generic-vnf-- |                                      |
| vnf-id--entitlements-entitlement--gr |                                      |
| oup-uuid---resource-uuid--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing entitlement       |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/entitlements/entitlement/{gro |                                      |
| up-uuid}/{resource-uuid} <#operation |                                      |
| --network-generic-vnfs-generic-vnf-- |                                      |
| vnf-id--entitlements-entitlement--gr |                                      |
| oup-uuid---resource-uuid--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/entitlements/entitlement/{gro |                                      |
| up-uuid}/{resource-uuid}/relationshi |                                      |
| p-list/relationship <#operation--net |                                      |
| work-generic-vnfs-generic-vnf--vnf-i |                                      |
| d--entitlements-entitlement--group-u |                                      |
| uid---resource-uuid--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/entitlements/entitlement/{gro |                                      |
| up-uuid}/{resource-uuid}/relationshi |                                      |
| p-list/relationship <#operation--net |                                      |
| work-generic-vnfs-generic-vnf--vnf-i |                                      |
| d--entitlements-entitlement--group-u |                                      |
| uid---resource-uuid--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces <#operation--net |                                      |
| work-generic-vnfs-generic-vnf--vnf-i |                                      |
| d--l-interfaces-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name} <#operation--network-ge |                                      |
| neric-vnfs-generic-vnf--vnf-id--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l-interface                          |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name} <#operation--network-ge |                                      |
| neric-vnfs-generic-vnf--vnf-id--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name} <#operation--network-ge |                                      |
| neric-vnfs-generic-vnf--vnf-id--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv4-addre |                                      |
| ss-list/{l3-interface-ipv4-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv4-address-list--l3-interface-ip |                                      |
| v4-address--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv4-addre |                                      |
| ss-list/{l3-interface-ipv4-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv4-address-list--l3-interface-ip |                                      |
| v4-address--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv4-addre |                                      |
| ss-list/{l3-interface-ipv4-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv4-address-list--l3-interface-ip |                                      |
| v4-address--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv4-addre |                                      |
| ss-list/{l3-interface-ipv4-address}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-generic-vnfs-generic |                                      |
| -vnf--vnf-id--l-interfaces-l-interfa |                                      |
| ce--interface-name--l3-interface-ipv |                                      |
| 4-address-list--l3-interface-ipv4-ad |                                      |
| dress--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv4-addre |                                      |
| ss-list/{l3-interface-ipv4-address}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-generic-vnfs-generic |                                      |
| -vnf--vnf-id--l-interfaces-l-interfa |                                      |
| ce--interface-name--l3-interface-ipv |                                      |
| 4-address-list--l3-interface-ipv4-ad |                                      |
| dress--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv6-addre |                                      |
| ss-list/{l3-interface-ipv6-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv6-address-list--l3-interface-ip |                                      |
| v6-address--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv6-addre |                                      |
| ss-list/{l3-interface-ipv6-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv6-address-list--l3-interface-ip |                                      |
| v6-address--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv6-addre |                                      |
| ss-list/{l3-interface-ipv6-address}  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--l3-interfac |                                      |
| e-ipv6-address-list--l3-interface-ip |                                      |
| v6-address--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv6-addre |                                      |
| ss-list/{l3-interface-ipv6-address}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-generic-vnfs-generic |                                      |
| -vnf--vnf-id--l-interfaces-l-interfa |                                      |
| ce--interface-name--l3-interface-ipv |                                      |
| 6-address-list--l3-interface-ipv6-ad |                                      |
| dress--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/l3-interface-ipv6-addre |                                      |
| ss-list/{l3-interface-ipv6-address}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-generic-vnfs-generic |                                      |
| -vnf--vnf-id--l-interfaces-l-interfa |                                      |
| ce--interface-name--l3-interface-ipv |                                      |
| 6-address-list--l3-interface-ipv6-ad |                                      |
| dress--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/relationship-list/relat |                                      |
| ionship <#operation--network-generic |                                      |
| -vnfs-generic-vnf--vnf-id--l-interfa |                                      |
| ces-l-interface--interface-name--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/relationship-list/relat |                                      |
| ionship <#operation--network-generic |                                      |
| -vnfs-generic-vnf--vnf-id--l-interfa |                                      |
| ces-l-interface--interface-name--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--l-interfaces-l-interface--inte |                                      |
| rface-name--sriov-vfs-get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs/sriov-vf/{pci |                                      |
| -id} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--sriov- |                                      |
| vfs-sriov-vf--pci-id--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | sriov-vf                             |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs/sriov-vf/{pci |                                      |
| -id} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--sriov- |                                      |
| vfs-sriov-vf--pci-id--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs/sriov-vf/{pci |                                      |
| -id} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--sriov- |                                      |
| vfs-sriov-vf--pci-id--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs/sriov-vf/{pci |                                      |
| -id}/relationship-list/relationship  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--sriov-vfs-s |                                      |
| riov-vf--pci-id--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/sriov-vfs/sriov-vf/{pci |                                      |
| -id}/relationship-list/relationship  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--sriov-vfs-s |                                      |
| riov-vf--pci-id--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans <#operation--netw |                                      |
| ork-generic-vnfs-generic-vnf--vnf-id |                                      |
| --l-interfaces-l-interface--interfac |                                      |
| e-name--vlans-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace} <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-generic-vnfs-generic-vn |                                      |
| f--vnf-id--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/relationship-list/relationship  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--vlans-vlan- |                                      |
| -vlan-interface--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/l-interfaces/l-interface/{int |                                      |
| erface-name}/vlans/vlan/{vlan-interf |                                      |
| ace}/relationship-list/relationship  |                                      |
| <#operation--network-generic-vnfs-ge |                                      |
| neric-vnf--vnf-id--l-interfaces-l-in |                                      |
| terface--interface-name--vlans-vlan- |                                      |
| -vlan-interface--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interfaces               |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces <#operation--n |                                      |
| etwork-generic-vnfs-generic-vnf--vnf |                                      |
| -id--lag-interfaces-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interface                |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | lag-interface                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing lag-interface     |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces <#oper |                                      |
| ation--network-generic-vnfs-generic- |                                      |
| vnf--vnf-id--lag-interfaces-lag-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l-interface                          |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-generic-vnfs-generic-vnf--vn |                                      |
| f-id--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-generic-vn |                                      |
| fs-generic-vnf--vnf-id--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/relationship- |                                      |
| list/relationship <#operation--netwo |                                      |
| rk-generic-vnfs-generic-vnf--vnf-id- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/relationship- |                                      |
| list/relationship <#operation--netwo |                                      |
| rk-generic-vnfs-generic-vnf--vnf-id- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs <#o |                                      |
| peration--network-generic-vnfs-gener |                                      |
| ic-vnf--vnf-id--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--srio |                                      |
| v-vfs-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | sriov-vf                             |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id}/relationship-list/rel |                                      |
| ationship <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id}/relationship-list/rel |                                      |
| ationship <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans <#opera |                                      |
| tion--network-generic-vnfs-generic-v |                                      |
| nf--vnf-id--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| generic-vnfs-generic-vnf--vnf-id--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv4-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-generic-vnfs-gener |                                      |
| ic-vnf--vnf-id--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-generic-vnfs-gener |                                      |
| ic-vnf--vnf-id--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/generic-vnfs/generic-vnf/{v | l3-interface-ipv6-address-list       |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-generic-vnfs-gener |                                      |
| ic-vnf--vnf-id--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-generic-vnfs-gener |                                      |
| ic-vnf--vnf-id--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/relationship-list/rel |                                      |
| ationship <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/relationship-list/rel |                                      |
| ationship <#operation--network-gener |                                      |
| ic-vnfs-generic-vnf--vnf-id--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/relationship-list/r |                                      |
| elationship <#operation--network-gen |                                      |
| eric-vnfs-generic-vnf--vnf-id--lag-i |                                      |
| nterfaces-lag-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/relationship-list/r |                                      |
| elationship <#operation--network-gen |                                      |
| eric-vnfs-generic-vnf--vnf-id--lag-i |                                      |
| nterfaces-lag-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns licenses                     |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/licenses <#operation--network |                                      |
| -generic-vnfs-generic-vnf--vnf-id--l |                                      |
| icenses-get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns license                      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/licenses/license/{group-uuid} |                                      |
| /{resource-uuid} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| licenses-license--group-uuid---resou |                                      |
| rce-uuid--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing license |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/licenses/license/{group-uuid} |                                      |
| /{resource-uuid} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| licenses-license--group-uuid---resou |                                      |
| rce-uuid--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing license           |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/licenses/license/{group-uuid} |                                      |
| /{resource-uuid} <#operation--networ |                                      |
| k-generic-vnfs-generic-vnf--vnf-id-- |                                      |
| licenses-license--group-uuid---resou |                                      |
| rce-uuid--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/licenses/license/{group-uuid} |                                      |
| /{resource-uuid}/relationship-list/r |                                      |
| elationship <#operation--network-gen |                                      |
| eric-vnfs-generic-vnf--vnf-id--licen |                                      |
| ses-license--group-uuid---resource-u |                                      |
| uid--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/licenses/license/{group-uuid} |                                      |
| /{resource-uuid}/relationship-list/r |                                      |
| elationship <#operation--network-gen |                                      |
| eric-vnfs-generic-vnf--vnf-id--licen |                                      |
| ses-license--group-uuid---resource-u |                                      |
| uid--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/relationship-list/relationshi |                                      |
| p <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/relationship-list/relationshi |                                      |
| p <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vf-modules                   |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/vf-modules <#operation--netwo |                                      |
| rk-generic-vnfs-generic-vnf--vnf-id- |                                      |
| -vf-modules-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vf-module                    |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/vf-modules/vf-module/{vf-modu |                                      |
| le-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--vf-modules |                                      |
| -vf-module--vf-module-id--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/generic-vnfs/generic-vnf/{v | vf-module                            |
| nf-id}/vf-modules/vf-module/{vf-modu |                                      |
| le-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--vf-modules |                                      |
| -vf-module--vf-module-id--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vf-module         |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/vf-modules/vf-module/{vf-modu |                                      |
| le-id} <#operation--network-generic- |                                      |
| vnfs-generic-vnf--vnf-id--vf-modules |                                      |
| -vf-module--vf-module-id--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/generic-vnfs/generic-vnf/{v | relationships                        |
| nf-id}/vf-modules/vf-module/{vf-modu |                                      |
| le-id}/relationship-list/relationshi |                                      |
| p <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--vf-modules-vf-m |                                      |
| odule--vf-module-id--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/generic-vnfs/generic-vnf/{v |                                      |
| nf-id}/vf-modules/vf-module/{vf-modu |                                      |
| le-id}/relationship-list/relationshi |                                      |
| p <#operation--network-generic-vnfs- |                                      |
| generic-vnf--vnf-id--vf-modules-vf-m |                                      |
| odule--vf-module-id--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns instance-groups              |
| /network/instance-groups <#operation |                                      |
| --network-instance-groups-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns instance-group               |
| /network/instance-groups/instance-gr |                                      |
| oup/{id} <#operation--network-instan |                                      |
| ce-groups-instance-group--id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/instance-groups/instance-gr | instance-group                       |
| oup/{id} <#operation--network-instan |                                      |
| ce-groups-instance-group--id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing instance-group    |
| /network/instance-groups/instance-gr |                                      |
| oup/{id} <#operation--network-instan |                                      |
| ce-groups-instance-group--id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/instance-groups/instance-gr | relationships                        |
| oup/{id}/relationship-list/relations |                                      |
| hip <#operation--network-instance-gr |                                      |
| oups-instance-group--id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/instance-groups/instance-gr |                                      |
| oup/{id}/relationship-list/relations |                                      |
| hip <#operation--network-instance-gr |                                      |
| oups-instance-group--id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ipsec-configurations         |
| /network/ipsec-configurations <#oper |                                      |
| ation--network-ipsec-configurations- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ipsec-configuration          |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d} <#operation--network-ipsec-config |                                      |
| urations-ipsec-configuration--ipsec- |                                      |
| configuration-id--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/ipsec-configurations/ipsec- | ipsec-configuration                  |
| configuration/{ipsec-configuration-i |                                      |
| d} <#operation--network-ipsec-config |                                      |
| urations-ipsec-configuration--ipsec- |                                      |
| configuration-id--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/ipsec-configurations/ipsec- | ipsec-configuration                  |
| configuration/{ipsec-configuration-i |                                      |
| d} <#operation--network-ipsec-config |                                      |
| urations-ipsec-configuration--ipsec- |                                      |
| configuration-id--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/ipsec-configurations/ipsec- | relationships                        |
| configuration/{ipsec-configuration-i |                                      |
| d}/relationship-list/relationship <# |                                      |
| operation--network-ipsec-configurati |                                      |
| ons-ipsec-configuration--ipsec-confi |                                      |
| guration-id--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d}/relationship-list/relationship <# |                                      |
| operation--network-ipsec-configurati |                                      |
| ons-ipsec-configuration--ipsec-confi |                                      |
| guration-id--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vig-servers                  |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers <#operation--network- |                                      |
| ipsec-configurations-ipsec-configura |                                      |
| tion--ipsec-configuration-id--vig-se |                                      |
| rvers-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vig-server                   |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers/vig-server/{vig-addre |                                      |
| ss-type} <#operation--network-ipsec- |                                      |
| configurations-ipsec-configuration-- |                                      |
| ipsec-configuration-id--vig-servers- |                                      |
| vig-server--vig-address-type--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/ipsec-configurations/ipsec- | vig-server                           |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers/vig-server/{vig-addre |                                      |
| ss-type} <#operation--network-ipsec- |                                      |
| configurations-ipsec-configuration-- |                                      |
| ipsec-configuration-id--vig-servers- |                                      |
| vig-server--vig-address-type--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vig-server        |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers/vig-server/{vig-addre |                                      |
| ss-type} <#operation--network-ipsec- |                                      |
| configurations-ipsec-configuration-- |                                      |
| ipsec-configuration-id--vig-servers- |                                      |
| vig-server--vig-address-type--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/ipsec-configurations/ipsec- | relationships                        |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers/vig-server/{vig-addre |                                      |
| ss-type}/relationship-list/relations |                                      |
| hip <#operation--network-ipsec-confi |                                      |
| gurations-ipsec-configuration--ipsec |                                      |
| -configuration-id--vig-servers-vig-s |                                      |
| erver--vig-address-type--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/ipsec-configurations/ipsec- |                                      |
| configuration/{ipsec-configuration-i |                                      |
| d}/vig-servers/vig-server/{vig-addre |                                      |
| ss-type}/relationship-list/relations |                                      |
| hip <#operation--network-ipsec-confi |                                      |
| gurations-ipsec-configuration--ipsec |                                      |
| -configuration-id--vig-servers-vig-s |                                      |
| erver--vig-address-type--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l3-networks                  |
| /network/l3-networks <#operation--ne |                                      |
| twork-l3-networks-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l3-network                   |
| /network/l3-networks/l3-network/{net |                                      |
| work-id} <#operation--network-l3-net |                                      |
| works-l3-network--network-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/l3-networks/l3-network/{net | l3-network                           |
| work-id} <#operation--network-l3-net |                                      |
| works-l3-network--network-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l3-network        |
| /network/l3-networks/l3-network/{net |                                      |
| work-id} <#operation--network-l3-net |                                      |
| works-l3-network--network-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ctag-assignments             |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/ctag-assignments <#operatio |                                      |
| n--network-l3-networks-l3-network--n |                                      |
| etwork-id--ctag-assignments-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns ctag-assignment              |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/ctag-assignments/ctag-assig |                                      |
| nment/{vlan-id-inner} <#operation--n |                                      |
| etwork-l3-networks-l3-network--netwo |                                      |
| rk-id--ctag-assignments-ctag-assignm |                                      |
| ent--vlan-id-inner--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/l3-networks/l3-network/{net | ctag-assignment                      |
| work-id}/ctag-assignments/ctag-assig |                                      |
| nment/{vlan-id-inner} <#operation--n |                                      |
| etwork-l3-networks-l3-network--netwo |                                      |
| rk-id--ctag-assignments-ctag-assignm |                                      |
| ent--vlan-id-inner--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing ctag-assignment   |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/ctag-assignments/ctag-assig |                                      |
| nment/{vlan-id-inner} <#operation--n |                                      |
| etwork-l3-networks-l3-network--netwo |                                      |
| rk-id--ctag-assignments-ctag-assignm |                                      |
| ent--vlan-id-inner--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/l3-networks/l3-network/{net | relationships                        |
| work-id}/ctag-assignments/ctag-assig |                                      |
| nment/{vlan-id-inner}/relationship-l |                                      |
| ist/relationship <#operation--networ |                                      |
| k-l3-networks-l3-network--network-id |                                      |
| --ctag-assignments-ctag-assignment-- |                                      |
| vlan-id-inner--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/ctag-assignments/ctag-assig |                                      |
| nment/{vlan-id-inner}/relationship-l |                                      |
| ist/relationship <#operation--networ |                                      |
| k-l3-networks-l3-network--network-id |                                      |
| --ctag-assignments-ctag-assignment-- |                                      |
| vlan-id-inner--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/l3-networks/l3-network/{net | relationships                        |
| work-id}/relationship-list/relations |                                      |
| hip <#operation--network-l3-networks |                                      |
| -l3-network--network-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/relationship-list/relations |                                      |
| hip <#operation--network-l3-networks |                                      |
| -l3-network--network-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns segmentation-assignments     |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/segmentation-assignments <# |                                      |
| operation--network-l3-networks-l3-ne |                                      |
| twork--network-id--segmentation-assi |                                      |
| gnments-get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns segmentation-assignment      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/segmentation-assignments/se |                                      |
| gmentation-assignment/{segmentation- |                                      |
| id} <#operation--network-l3-networks |                                      |
| -l3-network--network-id--segmentatio |                                      |
| n-assignments-segmentation-assignmen |                                      |
| t--segmentation-id--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/l3-networks/l3-network/{net | segmentation-assignment              |
| work-id}/segmentation-assignments/se |                                      |
| gmentation-assignment/{segmentation- |                                      |
| id} <#operation--network-l3-networks |                                      |
| -l3-network--network-id--segmentatio |                                      |
| n-assignments-segmentation-assignmen |                                      |
| t--segmentation-id--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/l3-networks/l3-network/{net | segmentation-assignment              |
| work-id}/segmentation-assignments/se |                                      |
| gmentation-assignment/{segmentation- |                                      |
| id} <#operation--network-l3-networks |                                      |
| -l3-network--network-id--segmentatio |                                      |
| n-assignments-segmentation-assignmen |                                      |
| t--segmentation-id--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/l3-networks/l3-network/{net | relationships                        |
| work-id}/segmentation-assignments/se |                                      |
| gmentation-assignment/{segmentation- |                                      |
| id}/relationship-list/relationship < |                                      |
| #operation--network-l3-networks-l3-n |                                      |
| etwork--network-id--segmentation-ass |                                      |
| ignments-segmentation-assignment--se |                                      |
| gmentation-id--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/segmentation-assignments/se |                                      |
| gmentation-assignment/{segmentation- |                                      |
| id}/relationship-list/relationship < |                                      |
| #operation--network-l3-networks-l3-n |                                      |
| etwork--network-id--segmentation-ass |                                      |
| ignments-segmentation-assignment--se |                                      |
| gmentation-id--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns subnets                      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets <#operation--networ |                                      |
| k-l3-networks-l3-network--network-id |                                      |
| --subnets-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns subnet                       |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}  |                                      |
| <#operation--network-l3-networks-l3- |                                      |
| network--network-id--subnets-subnet- |                                      |
| -subnet-id--get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing subnet  |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}  |                                      |
| <#operation--network-l3-networks-l3- |                                      |
| network--network-id--subnets-subnet- |                                      |
| -subnet-id--put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing subnet            |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}  |                                      |
| <#operation--network-l3-networks-l3- |                                      |
| network--network-id--subnets-subnet- |                                      |
| -subnet-id--delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns host-routes                  |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes <#operation--network-l3- |                                      |
| networks-l3-network--network-id--sub |                                      |
| nets-subnet--subnet-id--host-routes- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns host-route                   |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes/host-route/{host-route-i |                                      |
| d} <#operation--network-l3-networks- |                                      |
| l3-network--network-id--subnets-subn |                                      |
| et--subnet-id--host-routes-host-rout |                                      |
| e--host-route-id--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/l3-networks/l3-network/{net | host-route                           |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes/host-route/{host-route-i |                                      |
| d} <#operation--network-l3-networks- |                                      |
| l3-network--network-id--subnets-subn |                                      |
| et--subnet-id--host-routes-host-rout |                                      |
| e--host-route-id--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing host-route        |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes/host-route/{host-route-i |                                      |
| d} <#operation--network-l3-networks- |                                      |
| l3-network--network-id--subnets-subn |                                      |
| et--subnet-id--host-routes-host-rout |                                      |
| e--host-route-id--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/l3-networks/l3-network/{net | relationships                        |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes/host-route/{host-route-i |                                      |
| d}/relationship-list/relationship <# |                                      |
| operation--network-l3-networks-l3-ne |                                      |
| twork--network-id--subnets-subnet--s |                                      |
| ubnet-id--host-routes-host-route--ho |                                      |
| st-route-id--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| host-routes/host-route/{host-route-i |                                      |
| d}/relationship-list/relationship <# |                                      |
| operation--network-l3-networks-l3-ne |                                      |
| twork--network-id--subnets-subnet--s |                                      |
| ubnet-id--host-routes-host-route--ho |                                      |
| st-route-id--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/l3-networks/l3-network/{net | relationships                        |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-l3-networks-l3-netwo |                                      |
| rk--network-id--subnets-subnet--subn |                                      |
| et-id--relationship-list-relationshi |                                      |
| p-put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/l3-networks/l3-network/{net |                                      |
| work-id}/subnets/subnet/{subnet-id}/ |                                      |
| relationship-list/relationship <#ope |                                      |
| ration--network-l3-networks-l3-netwo |                                      |
| rk--network-id--subnets-subnet--subn |                                      |
| et-id--relationship-list-relationshi |                                      |
| p-delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-links                    |
| /network/lag-links <#operation--netw |                                      |
| ork-lag-links-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-link                     |
| /network/lag-links/lag-link/{link-na |                                      |
| me} <#operation--network-lag-links-l |                                      |
| ag-link--link-name--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/lag-links/lag-link/{link-na | lag-link                             |
| me} <#operation--network-lag-links-l |                                      |
| ag-link--link-name--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing lag-link          |
| /network/lag-links/lag-link/{link-na |                                      |
| me} <#operation--network-lag-links-l |                                      |
| ag-link--link-name--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/lag-links/lag-link/{link-na | relationships                        |
| me}/relationship-list/relationship < |                                      |
| #operation--network-lag-links-lag-li |                                      |
| nk--link-name--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/lag-links/lag-link/{link-na |                                      |
| me}/relationship-list/relationship < |                                      |
| #operation--network-lag-links-lag-li |                                      |
| nk--link-name--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns logical-links                |
| /network/logical-links <#operation-- |                                      |
| network-logical-links-get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns logical-link                 |
| /network/logical-links/logical-link/ |                                      |
| {link-name} <#operation--network-log |                                      |
| ical-links-logical-link--link-name-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/logical-links/logical-link/ | logical-link                         |
| {link-name} <#operation--network-log |                                      |
| ical-links-logical-link--link-name-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing logical-link      |
| /network/logical-links/logical-link/ |                                      |
| {link-name} <#operation--network-log |                                      |
| ical-links-logical-link--link-name-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/logical-links/logical-link/ | relationships                        |
| {link-name}/relationship-list/relati |                                      |
| onship <#operation--network-logical- |                                      |
| links-logical-link--link-name--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/logical-links/logical-link/ |                                      |
| {link-name}/relationship-list/relati |                                      |
| onship <#operation--network-logical- |                                      |
| links-logical-link--link-name--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns multicast-configurations     |
| /network/multicast-configurations <# |                                      |
| operation--network-multicast-configu |                                      |
| rations-get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns multicast-configuration      |
| /network/multicast-configurations/mu |                                      |
| lticast-configuration/{multicast-con |                                      |
| figuration-id} <#operation--network- |                                      |
| multicast-configurations-multicast-c |                                      |
| onfiguration--multicast-configuratio |                                      |
| n-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/multicast-configurations/mu | multicast-configuration              |
| lticast-configuration/{multicast-con |                                      |
| figuration-id} <#operation--network- |                                      |
| multicast-configurations-multicast-c |                                      |
| onfiguration--multicast-configuratio |                                      |
| n-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/multicast-configurations/mu | multicast-configuration              |
| lticast-configuration/{multicast-con |                                      |
| figuration-id} <#operation--network- |                                      |
| multicast-configurations-multicast-c |                                      |
| onfiguration--multicast-configuratio |                                      |
| n-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/multicast-configurations/mu | relationships                        |
| lticast-configuration/{multicast-con |                                      |
| figuration-id}/relationship-list/rel |                                      |
| ationship <#operation--network-multi |                                      |
| cast-configurations-multicast-config |                                      |
| uration--multicast-configuration-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/multicast-configurations/mu |                                      |
| lticast-configuration/{multicast-con |                                      |
| figuration-id}/relationship-list/rel |                                      |
| ationship <#operation--network-multi |                                      |
| cast-configurations-multicast-config |                                      |
| uration--multicast-configuration-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns network-policies             |
| /network/network-policies <#operatio |                                      |
| n--network-network-policies-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns network-policy               |
| /network/network-policies/network-po |                                      |
| licy/{network-policy-id} <#operation |                                      |
| --network-network-policies-network-p |                                      |
| olicy--network-policy-id--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/network-policies/network-po | network-policy                       |
| licy/{network-policy-id} <#operation |                                      |
| --network-network-policies-network-p |                                      |
| olicy--network-policy-id--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing network-policy    |
| /network/network-policies/network-po |                                      |
| licy/{network-policy-id} <#operation |                                      |
| --network-network-policies-network-p |                                      |
| olicy--network-policy-id--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/network-policies/network-po | relationships                        |
| licy/{network-policy-id}/relationshi |                                      |
| p-list/relationship <#operation--net |                                      |
| work-network-policies-network-policy |                                      |
| --network-policy-id--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/network-policies/network-po |                                      |
| licy/{network-policy-id}/relationshi |                                      |
| p-list/relationship <#operation--net |                                      |
| work-network-policies-network-policy |                                      |
| --network-policy-id--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns newvces                      |
| /network/newvces <#operation--networ |                                      |
| k-newvces-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns newvce                       |
| /network/newvces/newvce/{vnf-id2} <# |                                      |
| operation--network-newvces-newvce--v |                                      |
| nf-id2--get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing newvce  |
| /network/newvces/newvce/{vnf-id2} <# |                                      |
| operation--network-newvces-newvce--v |                                      |
| nf-id2--put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing newvce            |
| /network/newvces/newvce/{vnf-id2} <# |                                      |
| operation--network-newvces-newvce--v |                                      |
| nf-id2--delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces <#operation--network-newv |                                      |
| ces-newvce--vnf-id2--l-interfaces-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me} <#operation--network-newvces-new |                                      |
| vce--vnf-id2--l-interfaces-l-interfa |                                      |
| ce--interface-name--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | l-interface                          |
| interfaces/l-interface/{interface-na |                                      |
| me} <#operation--network-newvces-new |                                      |
| vce--vnf-id2--l-interfaces-l-interfa |                                      |
| ce--interface-name--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me} <#operation--network-newvces-new |                                      |
| vce--vnf-id2--l-interfaces-l-interfa |                                      |
| ce--interface-name--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv4-address-list/{ |                                      |
| l3-interface-ipv4-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv4-address-list/{ |                                      |
| l3-interface-ipv4-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv4-address-list/{ |                                      |
| l3-interface-ipv4-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv4-address-lis |                                      |
| t--l3-interface-ipv4-address--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv4-address-list/{ |                                      |
| l3-interface-ipv4-address}/relations |                                      |
| hip-list/relationship <#operation--n |                                      |
| etwork-newvces-newvce--vnf-id2--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --l3-interface-ipv4-address-list--l3 |                                      |
| -interface-ipv4-address--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv4-address-list/{ |                                      |
| l3-interface-ipv4-address}/relations |                                      |
| hip-list/relationship <#operation--n |                                      |
| etwork-newvces-newvce--vnf-id2--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --l3-interface-ipv4-address-list--l3 |                                      |
| -interface-ipv4-address--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv6-address-list/{ |                                      |
| l3-interface-ipv6-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv6-address-list/{ |                                      |
| l3-interface-ipv6-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv6-address-list/{ |                                      |
| l3-interface-ipv6-address} <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--l3-interface-ipv6-address-lis |                                      |
| t--l3-interface-ipv6-address--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv6-address-list/{ |                                      |
| l3-interface-ipv6-address}/relations |                                      |
| hip-list/relationship <#operation--n |                                      |
| etwork-newvces-newvce--vnf-id2--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --l3-interface-ipv6-address-list--l3 |                                      |
| -interface-ipv6-address--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/l3-interface-ipv6-address-list/{ |                                      |
| l3-interface-ipv6-address}/relations |                                      |
| hip-list/relationship <#operation--n |                                      |
| etwork-newvces-newvce--vnf-id2--l-in |                                      |
| terfaces-l-interface--interface-name |                                      |
| --l3-interface-ipv6-address-list--l3 |                                      |
| -interface-ipv6-address--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/relationship-list/relationship < |                                      |
| #operation--network-newvces-newvce-- |                                      |
| vnf-id2--l-interfaces-l-interface--i |                                      |
| nterface-name--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/relationship-list/relationship < |                                      |
| #operation--network-newvces-newvce-- |                                      |
| vnf-id2--l-interfaces-l-interface--i |                                      |
| nterface-name--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs <#operation--network-n |                                      |
| ewvces-newvce--vnf-id2--l-interfaces |                                      |
| -l-interface--interface-name--sriov- |                                      |
| vfs-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs/sriov-vf/{pci-id} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--sriov-vfs-sriov-vf--pci- |                                      |
| id--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | sriov-vf                             |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs/sriov-vf/{pci-id} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--sriov-vfs-sriov-vf--pci- |                                      |
| id--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs/sriov-vf/{pci-id} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--sriov-vfs-sriov-vf--pci- |                                      |
| id--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs/sriov-vf/{pci-id}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--sriov-vfs-sriov-vf--pci-id--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/sriov-vfs/sriov-vf/{pci-id}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--sriov-vfs-sriov-vf--pci-id--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans <#operation--network-newvc |                                      |
| es-newvce--vnf-id2--l-interfaces-l-i |                                      |
| nterface--interface-name--vlans-get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface} <#op |                                      |
| eration--network-newvces-newvce--vnf |                                      |
| -id2--l-interfaces-l-interface--inte |                                      |
| rface-name--vlans-vlan--vlan-interfa |                                      |
| ce--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv4-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address}/relationship-list |                                      |
| /relationship <#operation--network-n |                                      |
| ewvces-newvce--vnf-id2--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--l3-interface-i |                                      |
| pv4-address-list--l3-interface-ipv4- |                                      |
| address--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address}/relationship-list |                                      |
| /relationship <#operation--network-n |                                      |
| ewvces-newvce--vnf-id2--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--l3-interface-i |                                      |
| pv4-address-list--l3-interface-ipv4- |                                      |
| address--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/newvces/newvce/{vnf-id2}/l- | l3-interface-ipv6-address-list       |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-newvces-newvce--vnf-id2--l-inter |                                      |
| faces-l-interface--interface-name--v |                                      |
| lans-vlan--vlan-interface--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address}/relationship-list |                                      |
| /relationship <#operation--network-n |                                      |
| ewvces-newvce--vnf-id2--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--l3-interface-i |                                      |
| pv6-address-list--l3-interface-ipv6- |                                      |
| address--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address}/relationship-list |                                      |
| /relationship <#operation--network-n |                                      |
| ewvces-newvce--vnf-id2--l-interfaces |                                      |
| -l-interface--interface-name--vlans- |                                      |
| vlan--vlan-interface--l3-interface-i |                                      |
| pv6-address-list--l3-interface-ipv6- |                                      |
| address--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/l- | relationships                        |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/l- |                                      |
| interfaces/l-interface/{interface-na |                                      |
| me}/vlans/vlan/{vlan-interface}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-newvces-newvce--vnf-id2- |                                      |
| -l-interfaces-l-interface--interface |                                      |
| -name--vlans-vlan--vlan-interface--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/newvces/newvce/{vnf-id2}/re | relationships                        |
| lationship-list/relationship <#opera |                                      |
| tion--network-newvces-newvce--vnf-id |                                      |
| 2--relationship-list-relationship-pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/newvces/newvce/{vnf-id2}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--network-newvces-newvce--vnf-id |                                      |
| 2--relationship-list-relationship-de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns physical-links               |
| /network/physical-links <#operation- |                                      |
| -network-physical-links-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns physical-link                |
| /network/physical-links/physical-lin |                                      |
| k/{link-name} <#operation--network-p |                                      |
| hysical-links-physical-link--link-na |                                      |
| me--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/physical-links/physical-lin | physical-link                        |
| k/{link-name} <#operation--network-p |                                      |
| hysical-links-physical-link--link-na |                                      |
| me--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing physical-link     |
| /network/physical-links/physical-lin |                                      |
| k/{link-name} <#operation--network-p |                                      |
| hysical-links-physical-link--link-na |                                      |
| me--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/physical-links/physical-lin | relationships                        |
| k/{link-name}/relationship-list/rela |                                      |
| tionship <#operation--network-physic |                                      |
| al-links-physical-link--link-name--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/physical-links/physical-lin |                                      |
| k/{link-name}/relationship-list/rela |                                      |
| tionship <#operation--network-physic |                                      |
| al-links-physical-link--link-name--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns pnfs                         |
| /network/pnfs <#operation--network-p |                                      |
| nfs-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns pnf                          |
| /network/pnfs/pnf/{pnf-name} <#opera |                                      |
| tion--network-pnfs-pnf--pnf-name--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing pnf     |
| /network/pnfs/pnf/{pnf-name} <#opera |                                      |
| tion--network-pnfs-pnf--pnf-name--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing pnf               |
| /network/pnfs/pnf/{pnf-name} <#opera |                                      |
| tion--network-pnfs-pnf--pnf-name--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interfaces               |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces <#operation--network-pnfs-pn |                                      |
| f--pnf-name--lag-interfaces-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interface                |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e} <#operation--network-pnfs-pnf--pn |                                      |
| f-name--lag-interfaces-lag-interface |                                      |
| --interface-name--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | lag-interface                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e} <#operation--network-pnfs-pnf--pn |                                      |
| f-name--lag-interfaces-lag-interface |                                      |
| --interface-name--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing lag-interface     |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e} <#operation--network-pnfs-pnf--pn |                                      |
| f-name--lag-interfaces-lag-interface |                                      |
| --interface-name--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces <#operation--network |                                      |
| -pnfs-pnf--pnf-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name} <#operation--network-pnfs-p |                                      |
| nf--pnf-name--lag-interfaces-lag-int |                                      |
| erface--interface-name--l-interfaces |                                      |
| -l-interface--interface-name--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | l-interface                          |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name} <#operation--network-pnfs-p |                                      |
| nf--pnf-name--lag-interfaces-lag-int |                                      |
| erface--interface-name--l-interfaces |                                      |
| -l-interface--interface-name--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name} <#operation--network-pnfs-p |                                      |
| nf--pnf-name--lag-interfaces-lag-int |                                      |
| erface--interface-name--l-interfaces |                                      |
| -l-interface--interface-name--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv4-address-l |                                      |
| ist/{l3-interface-ipv4-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv4-a |                                      |
| ddress-list--l3-interface-ipv4-addre |                                      |
| ss--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv4-address-l |                                      |
| ist/{l3-interface-ipv4-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv4-a |                                      |
| ddress-list--l3-interface-ipv4-addre |                                      |
| ss--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv4-address-l |                                      |
| ist/{l3-interface-ipv4-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv4-a |                                      |
| ddress-list--l3-interface-ipv4-addre |                                      |
| ss--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv4-address-l |                                      |
| ist/{l3-interface-ipv4-address}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-pnfs-pnf--pnf-name--lag- |                                      |
| interfaces-lag-interface--interface- |                                      |
| name--l-interfaces-l-interface--inte |                                      |
| rface-name--l3-interface-ipv4-addres |                                      |
| s-list--l3-interface-ipv4-address--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv4-address-l |                                      |
| ist/{l3-interface-ipv4-address}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-pnfs-pnf--pnf-name--lag- |                                      |
| interfaces-lag-interface--interface- |                                      |
| name--l-interfaces-l-interface--inte |                                      |
| rface-name--l3-interface-ipv4-addres |                                      |
| s-list--l3-interface-ipv4-address--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv6-address-l |                                      |
| ist/{l3-interface-ipv6-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv6-a |                                      |
| ddress-list--l3-interface-ipv6-addre |                                      |
| ss--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv6-address-l |                                      |
| ist/{l3-interface-ipv6-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv6-a |                                      |
| ddress-list--l3-interface-ipv6-addre |                                      |
| ss--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv6-address-l |                                      |
| ist/{l3-interface-ipv6-address} <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--l3-interface-ipv6-a |                                      |
| ddress-list--l3-interface-ipv6-addre |                                      |
| ss--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv6-address-l |                                      |
| ist/{l3-interface-ipv6-address}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-pnfs-pnf--pnf-name--lag- |                                      |
| interfaces-lag-interface--interface- |                                      |
| name--l-interfaces-l-interface--inte |                                      |
| rface-name--l3-interface-ipv6-addres |                                      |
| s-list--l3-interface-ipv6-address--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/l3-interface-ipv6-address-l |                                      |
| ist/{l3-interface-ipv6-address}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-pnfs-pnf--pnf-name--lag- |                                      |
| interfaces-lag-interface--interface- |                                      |
| name--l-interfaces-l-interface--inte |                                      |
| rface-name--l3-interface-ipv6-addres |                                      |
| s-list--l3-interface-ipv6-address--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/relationship-list/relations |                                      |
| hip <#operation--network-pnfs-pnf--p |                                      |
| nf-name--lag-interfaces-lag-interfac |                                      |
| e--interface-name--l-interfaces-l-in |                                      |
| terface--interface-name--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/relationship-list/relations |                                      |
| hip <#operation--network-pnfs-pnf--p |                                      |
| nf-name--lag-interfaces-lag-interfac |                                      |
| e--interface-name--l-interfaces-l-in |                                      |
| terface--interface-name--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs <#operation--netw |                                      |
| ork-pnfs-pnf--pnf-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--sriov-vfs-get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs/sriov-vf/{pci-id} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--sriov-vfs-srio |                                      |
| v-vf--pci-id--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | sriov-vf                             |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs/sriov-vf/{pci-id} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--sriov-vfs-srio |                                      |
| v-vf--pci-id--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs/sriov-vf/{pci-id} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--sriov-vfs-srio |                                      |
| v-vf--pci-id--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs/sriov-vf/{pci-id} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--sriov-vfs-sriov-vf- |                                      |
| -pci-id--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/sriov-vfs/sriov-vf/{pci-id} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--sriov-vfs-sriov-vf- |                                      |
| -pci-id--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans <#operation--network- |                                      |
| pnfs-pnf--pnf-name--lag-interfaces-l |                                      |
| ag-interface--interface-name--l-inte |                                      |
| rfaces-l-interface--interface-name-- |                                      |
| vlans-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
|  <#operation--network-pnfs-pnf--pnf- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--vlans-vlan--vl |                                      |
| an-interface--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv4-address-list/{l3- |                                      |
| interface-ipv4-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv4-address-list/{l3- |                                      |
| interface-ipv4-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv4-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv4-address-list/{l3- |                                      |
| interface-ipv4-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv4-address-list/{l3- |                                      |
| interface-ipv4-address}/relationship |                                      |
| -list/relationship <#operation--netw |                                      |
| ork-pnfs-pnf--pnf-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--l3-i |                                      |
| nterface-ipv4-address-list--l3-inter |                                      |
| face-ipv4-address--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv4-address-list/{l3- |                                      |
| interface-ipv4-address}/relationship |                                      |
| -list/relationship <#operation--netw |                                      |
| ork-pnfs-pnf--pnf-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--l3-i |                                      |
| nterface-ipv4-address-list--l3-inter |                                      |
| face-ipv4-address--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv6-address-list/{l3- |                                      |
| interface-ipv6-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv6-address-list/{l3- |                                      |
| interface-ipv6-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/lag-int | l3-interface-ipv6-address-list       |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv6-address-list/{l3- |                                      |
| interface-ipv6-address} <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv6-address-list/{l3- |                                      |
| interface-ipv6-address}/relationship |                                      |
| -list/relationship <#operation--netw |                                      |
| ork-pnfs-pnf--pnf-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--l3-i |                                      |
| nterface-ipv6-address-list--l3-inter |                                      |
| face-ipv6-address--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /l3-interface-ipv6-address-list/{l3- |                                      |
| interface-ipv6-address}/relationship |                                      |
| -list/relationship <#operation--netw |                                      |
| ork-pnfs-pnf--pnf-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--vlans-vlan--vlan-interface--l3-i |                                      |
| nterface-ipv6-address-list--l3-inter |                                      |
| face-ipv6-address--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/l-interfaces/l-interface/{interfa |                                      |
| ce-name}/vlans/vlan/{vlan-interface} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-pnfs-pnf--pnf-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--vlans-vlan--vlan-in |                                      |
| terface--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/lag-int | relationships                        |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/relationship-list/relationship <# |                                      |
| operation--network-pnfs-pnf--pnf-nam |                                      |
| e--lag-interfaces-lag-interface--int |                                      |
| erface-name--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/lag-int |                                      |
| erfaces/lag-interface/{interface-nam |                                      |
| e}/relationship-list/relationship <# |                                      |
| operation--network-pnfs-pnf--pnf-nam |                                      |
| e--lag-interfaces-lag-interface--int |                                      |
| erface-name--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interfaces                 |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces <#operation--network-pnfs-pnf- |                                      |
| -pnf-name--p-interfaces-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interface                  |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name} < |                                      |
| #operation--network-pnfs-pnf--pnf-na |                                      |
| me--p-interfaces-p-interface--interf |                                      |
| ace-name--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | p-interface                          |
| faces/p-interface/{interface-name} < |                                      |
| #operation--network-pnfs-pnf--pnf-na |                                      |
| me--p-interfaces-p-interface--interf |                                      |
| ace-name--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing p-interface       |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name} < |                                      |
| #operation--network-pnfs-pnf--pnf-na |                                      |
| me--p-interfaces-p-interface--interf |                                      |
| ace-name--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces <#operation--network-pnf |                                      |
| s-pnf--pnf-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame} <#operation--network-pnfs-pnf-- |                                      |
| pnf-name--p-interfaces-p-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | l-interface                          |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame} <#operation--network-pnfs-pnf-- |                                      |
| pnf-name--p-interfaces-p-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame} <#operation--network-pnfs-pnf-- |                                      |
| pnf-name--p-interfaces-p-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-pnfs-pnf--pnf-name--p-interf |                                      |
| aces-p-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv4-address-list/ |                                      |
| {l3-interface-ipv4-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-pnfs-pnf--pnf-name--p-interf |                                      |
| aces-p-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address} <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-pnfs-pnf--pnf-name--p-interf |                                      |
| aces-p-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/l3-interface-ipv6-address-list/ |                                      |
| {l3-interface-ipv6-address}/relation |                                      |
| ship-list/relationship <#operation-- |                                      |
| network-pnfs-pnf--pnf-name--p-interf |                                      |
| aces-p-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/relationship-list/relationship  |                                      |
| <#operation--network-pnfs-pnf--pnf-n |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/relationship-list/relationship  |                                      |
| <#operation--network-pnfs-pnf--pnf-n |                                      |
| ame--p-interfaces-p-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs <#operation--network- |                                      |
| pnfs-pnf--pnf-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--srio |                                      |
| v-vfs-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs/sriov-vf/{pci-id} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | sriov-vf                             |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs/sriov-vf/{pci-id} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs/sriov-vf/{pci-id} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs/sriov-vf/{pci-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/sriov-vfs/sriov-vf/{pci-id}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans <#operation--network-pnfs |                                      |
| -pnf--pnf-name--p-interfaces-p-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface} <#o |                                      |
| peration--network-pnfs-pnf--pnf-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv4-address-list/{l3-inte |                                      |
| rface-ipv4-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv4-address-list/{l3-inte |                                      |
| rface-ipv4-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv4-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv4-address-list/{l3-inte |                                      |
| rface-ipv4-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv4-address-list/{l3-inte |                                      |
| rface-ipv4-address}/relationship-lis |                                      |
| t/relationship <#operation--network- |                                      |
| pnfs-pnf--pnf-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv4-address-list/{l3-inte |                                      |
| rface-ipv4-address}/relationship-lis |                                      |
| t/relationship <#operation--network- |                                      |
| pnfs-pnf--pnf-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv6-address-list/{l3-inte |                                      |
| rface-ipv6-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv6-address-list/{l3-inte |                                      |
| rface-ipv6-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/pnfs/pnf/{pnf-name}/p-inter | l3-interface-ipv6-address-list       |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv6-address-list/{l3-inte |                                      |
| rface-ipv6-address} <#operation--net |                                      |
| work-pnfs-pnf--pnf-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv6-address-list/{l3-inte |                                      |
| rface-ipv6-address}/relationship-lis |                                      |
| t/relationship <#operation--network- |                                      |
| pnfs-pnf--pnf-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/l3- |                                      |
| interface-ipv6-address-list/{l3-inte |                                      |
| rface-ipv6-address}/relationship-lis |                                      |
| t/relationship <#operation--network- |                                      |
| pnfs-pnf--pnf-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/l |                                      |
| -interfaces/l-interface/{interface-n |                                      |
| ame}/vlans/vlan/{vlan-interface}/rel |                                      |
| ationship-list/relationship <#operat |                                      |
| ion--network-pnfs-pnf--pnf-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/r |                                      |
| elationship-list/relationship <#oper |                                      |
| ation--network-pnfs-pnf--pnf-name--p |                                      |
| -interfaces-p-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/r |                                      |
| elationship-list/relationship <#oper |                                      |
| ation--network-pnfs-pnf--pnf-name--p |                                      |
| -interfaces-p-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pfs                    |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs <#operation--network-pnfs-p |                                      |
| nf--pnf-name--p-interfaces-p-interfa |                                      |
| ce--interface-name--sriov-pfs-get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pf                     |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs/sriov-pf/{pf-pci-id} <#oper |                                      |
| ation--network-pnfs-pnf--pnf-name--p |                                      |
| -interfaces-p-interface--interface-n |                                      |
| ame--sriov-pfs-sriov-pf--pf-pci-id-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/pnfs/pnf/{pnf-name}/p-inter | sriov-pf                             |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs/sriov-pf/{pf-pci-id} <#oper |                                      |
| ation--network-pnfs-pnf--pnf-name--p |                                      |
| -interfaces-p-interface--interface-n |                                      |
| ame--sriov-pfs-sriov-pf--pf-pci-id-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-pf          |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs/sriov-pf/{pf-pci-id} <#oper |                                      |
| ation--network-pnfs-pnf--pnf-name--p |                                      |
| -interfaces-p-interface--interface-n |                                      |
| ame--sriov-pfs-sriov-pf--pf-pci-id-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/p-inter | relationships                        |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs/sriov-pf/{pf-pci-id}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --network-pnfs-pnf--pnf-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| sriov-pfs-sriov-pf--pf-pci-id--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/p-inter |                                      |
| faces/p-interface/{interface-name}/s |                                      |
| riov-pfs/sriov-pf/{pf-pci-id}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --network-pnfs-pnf--pnf-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| sriov-pfs-sriov-pf--pf-pci-id--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/pnfs/pnf/{pnf-name}/relatio | relationships                        |
| nship-list/relationship <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/pnfs/pnf/{pnf-name}/relatio |                                      |
| nship-list/relationship <#operation- |                                      |
| -network-pnfs-pnf--pnf-name--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns route-table-references       |
| /network/route-table-references <#op |                                      |
| eration--network-route-table-referen |                                      |
| ces-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns route-table-reference        |
| /network/route-table-references/rout |                                      |
| e-table-reference/{route-table-refer |                                      |
| ence-id} <#operation--network-route- |                                      |
| table-references-route-table-referen |                                      |
| ce--route-table-reference-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/route-table-references/rout | route-table-reference                |
| e-table-reference/{route-table-refer |                                      |
| ence-id} <#operation--network-route- |                                      |
| table-references-route-table-referen |                                      |
| ce--route-table-reference-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/route-table-references/rout | route-table-reference                |
| e-table-reference/{route-table-refer |                                      |
| ence-id} <#operation--network-route- |                                      |
| table-references-route-table-referen |                                      |
| ce--route-table-reference-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/route-table-references/rout | relationships                        |
| e-table-reference/{route-table-refer |                                      |
| ence-id}/relationship-list/relations |                                      |
| hip <#operation--network-route-table |                                      |
| -references-route-table-reference--r |                                      |
| oute-table-reference-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/route-table-references/rout |                                      |
| e-table-reference/{route-table-refer |                                      |
| ence-id}/relationship-list/relations |                                      |
| hip <#operation--network-route-table |                                      |
| -references-route-table-reference--r |                                      |
| oute-table-reference-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns site-pair-sets               |
| /network/site-pair-sets <#operation- |                                      |
| -network-site-pair-sets-get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns site-pair-set                |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id} <#operation--ne |                                      |
| twork-site-pair-sets-site-pair-set-- |                                      |
| site-pair-set-id--get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/site-pair-sets/site-pair-se | site-pair-set                        |
| t/{site-pair-set-id} <#operation--ne |                                      |
| twork-site-pair-sets-site-pair-set-- |                                      |
| site-pair-set-id--put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing site-pair-set     |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id} <#operation--ne |                                      |
| twork-site-pair-sets-site-pair-set-- |                                      |
| site-pair-set-id--delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/site-pair-sets/site-pair-se | relationships                        |
| t/{site-pair-set-id}/relationship-li |                                      |
| st/relationship <#operation--network |                                      |
| -site-pair-sets-site-pair-set--site- |                                      |
| pair-set-id--relationship-list-relat |                                      |
| ionship-put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/relationship-li |                                      |
| st/relationship <#operation--network |                                      |
| -site-pair-sets-site-pair-set--site- |                                      |
| pair-set-id--relationship-list-relat |                                      |
| ionship-delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns routing-instances            |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es <#operation--network-site-pair-se |                                      |
| ts-site-pair-set--site-pair-set-id-- |                                      |
| routing-instances-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns routing-instance             |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/site-pair-sets/site-pair-se | routing-instance                     |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing routing-instance  |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/site-pair-sets/site-pair-se | relationships                        |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/relationship-list/relationship |                                      |
|  <#operation--network-site-pair-sets |                                      |
| -site-pair-set--site-pair-set-id--ro |                                      |
| uting-instances-routing-instance--ro |                                      |
| uting-instance-id--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/relationship-list/relationship |                                      |
|  <#operation--network-site-pair-sets |                                      |
| -site-pair-set--site-pair-set-id--ro |                                      |
| uting-instances-routing-instance--ro |                                      |
| uting-instance-id--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns site-pairs                   |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs <#operation--networ |                                      |
| k-site-pair-sets-site-pair-set--site |                                      |
| -pair-set-id--routing-instances-rout |                                      |
| ing-instance--routing-instance-id--s |                                      |
| ite-pairs-get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns site-pair                    |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--site-pairs-s |                                      |
| ite-pair--site-pair-id--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/site-pair-sets/site-pair-se | site-pair                            |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--site-pairs-s |                                      |
| ite-pair--site-pair-id--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing site-pair         |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id} <#operation--network-site-pair |                                      |
| -sets-site-pair-set--site-pair-set-i |                                      |
| d--routing-instances-routing-instanc |                                      |
| e--routing-instance-id--site-pairs-s |                                      |
| ite-pair--site-pair-id--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns classes-of-service           |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service <#operation |                                      |
| --network-site-pair-sets-site-pair-s |                                      |
| et--site-pair-set-id--routing-instan |                                      |
| ces-routing-instance--routing-instan |                                      |
| ce-id--site-pairs-site-pair--site-pa |                                      |
| ir-id--classes-of-service-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns class-of-service             |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service/class-of-se |                                      |
| rvice/{cos} <#operation--network-sit |                                      |
| e-pair-sets-site-pair-set--site-pair |                                      |
| -set-id--routing-instances-routing-i |                                      |
| nstance--routing-instance-id--site-p |                                      |
| airs-site-pair--site-pair-id--classe |                                      |
| s-of-service-class-of-service--cos-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/site-pair-sets/site-pair-se | class-of-service                     |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service/class-of-se |                                      |
| rvice/{cos} <#operation--network-sit |                                      |
| e-pair-sets-site-pair-set--site-pair |                                      |
| -set-id--routing-instances-routing-i |                                      |
| nstance--routing-instance-id--site-p |                                      |
| airs-site-pair--site-pair-id--classe |                                      |
| s-of-service-class-of-service--cos-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing class-of-service  |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service/class-of-se |                                      |
| rvice/{cos} <#operation--network-sit |                                      |
| e-pair-sets-site-pair-set--site-pair |                                      |
| -set-id--routing-instances-routing-i |                                      |
| nstance--routing-instance-id--site-p |                                      |
| airs-site-pair--site-pair-id--classe |                                      |
| s-of-service-class-of-service--cos-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/site-pair-sets/site-pair-se | relationships                        |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service/class-of-se |                                      |
| rvice/{cos}/relationship-list/relati |                                      |
| onship <#operation--network-site-pai |                                      |
| r-sets-site-pair-set--site-pair-set- |                                      |
| id--routing-instances-routing-instan |                                      |
| ce--routing-instance-id--site-pairs- |                                      |
| site-pair--site-pair-id--classes-of- |                                      |
| service-class-of-service--cos--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/classes-of-service/class-of-se |                                      |
| rvice/{cos}/relationship-list/relati |                                      |
| onship <#operation--network-site-pai |                                      |
| r-sets-site-pair-set--site-pair-set- |                                      |
| id--routing-instances-routing-instan |                                      |
| ce--routing-instance-id--site-pairs- |                                      |
| site-pair--site-pair-id--classes-of- |                                      |
| service-class-of-service--cos--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/site-pair-sets/site-pair-se | relationships                        |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/relationship-list/relationship |                                      |
|  <#operation--network-site-pair-sets |                                      |
| -site-pair-set--site-pair-set-id--ro |                                      |
| uting-instances-routing-instance--ro |                                      |
| uting-instance-id--site-pairs-site-p |                                      |
| air--site-pair-id--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/site-pair-sets/site-pair-se |                                      |
| t/{site-pair-set-id}/routing-instanc |                                      |
| es/routing-instance/{routing-instanc |                                      |
| e-id}/site-pairs/site-pair/{site-pai |                                      |
| r-id}/relationship-list/relationship |                                      |
|  <#operation--network-site-pair-sets |                                      |
| -site-pair-set--site-pair-set-id--ro |                                      |
| uting-instances-routing-instance--ro |                                      |
| uting-instance-id--site-pairs-site-p |                                      |
| air--site-pair-id--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vces                         |
| /network/vces <#operation--network-v |                                      |
| ces-get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vce                          |
| /network/vces/vce/{vnf-id} <#operati |                                      |
| on--network-vces-vce--vnf-id--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vce     |
| /network/vces/vce/{vnf-id} <#operati |                                      |
| on--network-vces-vce--vnf-id--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vce               |
| /network/vces/vce/{vnf-id} <#operati |                                      |
| on--network-vces-vce--vnf-id--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns entitlements                 |
| /network/vces/vce/{vnf-id}/entitleme |                                      |
| nts <#operation--network-vces-vce--v |                                      |
| nf-id--entitlements-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns entitlement                  |
| /network/vces/vce/{vnf-id}/entitleme |                                      |
| nts/entitlement/{group-uuid}/{resour |                                      |
| ce-uuid} <#operation--network-vces-v |                                      |
| ce--vnf-id--entitlements-entitlement |                                      |
| --group-uuid---resource-uuid--get>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vces/vce/{vnf-id}/entitleme | entitlement                          |
| nts/entitlement/{group-uuid}/{resour |                                      |
| ce-uuid} <#operation--network-vces-v |                                      |
| ce--vnf-id--entitlements-entitlement |                                      |
| --group-uuid---resource-uuid--put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing entitlement       |
| /network/vces/vce/{vnf-id}/entitleme |                                      |
| nts/entitlement/{group-uuid}/{resour |                                      |
| ce-uuid} <#operation--network-vces-v |                                      |
| ce--vnf-id--entitlements-entitlement |                                      |
| --group-uuid---resource-uuid--delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vces/vce/{vnf-id}/entitleme | relationships                        |
| nts/entitlement/{group-uuid}/{resour |                                      |
| ce-uuid}/relationship-list/relations |                                      |
| hip <#operation--network-vces-vce--v |                                      |
| nf-id--entitlements-entitlement--gro |                                      |
| up-uuid---resource-uuid--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vces/vce/{vnf-id}/entitleme |                                      |
| nts/entitlement/{group-uuid}/{resour |                                      |
| ce-uuid}/relationship-list/relations |                                      |
| hip <#operation--network-vces-vce--v |                                      |
| nf-id--entitlements-entitlement--gro |                                      |
| up-uuid---resource-uuid--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns licenses                     |
| /network/vces/vce/{vnf-id}/licenses  |                                      |
| <#operation--network-vces-vce--vnf-i |                                      |
| d--licenses-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns license                      |
| /network/vces/vce/{vnf-id}/licenses/ |                                      |
| license/{group-uuid}/{resource-uuid} |                                      |
|  <#operation--network-vces-vce--vnf- |                                      |
| id--licenses-license--group-uuid---r |                                      |
| esource-uuid--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing license |
| /network/vces/vce/{vnf-id}/licenses/ |                                      |
| license/{group-uuid}/{resource-uuid} |                                      |
|  <#operation--network-vces-vce--vnf- |                                      |
| id--licenses-license--group-uuid---r |                                      |
| esource-uuid--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing license           |
| /network/vces/vce/{vnf-id}/licenses/ |                                      |
| license/{group-uuid}/{resource-uuid} |                                      |
|  <#operation--network-vces-vce--vnf- |                                      |
| id--licenses-license--group-uuid---r |                                      |
| esource-uuid--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vces/vce/{vnf-id}/licenses/ | relationships                        |
| license/{group-uuid}/{resource-uuid} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-vces-vce--vnf-id--l |                                      |
| icenses-license--group-uuid---resour |                                      |
| ce-uuid--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vces/vce/{vnf-id}/licenses/ |                                      |
| license/{group-uuid}/{resource-uuid} |                                      |
| /relationship-list/relationship <#op |                                      |
| eration--network-vces-vce--vnf-id--l |                                      |
| icenses-license--group-uuid---resour |                                      |
| ce-uuid--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns port-groups                  |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps <#operation--network-vces-vce--vn |                                      |
| f-id--port-groups-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns port-group                   |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id} <#opera |                                      |
| tion--network-vces-vce--vnf-id--port |                                      |
| -groups-port-group--interface-id--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vces/vce/{vnf-id}/port-grou | port-group                           |
| ps/port-group/{interface-id} <#opera |                                      |
| tion--network-vces-vce--vnf-id--port |                                      |
| -groups-port-group--interface-id--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing port-group        |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id} <#opera |                                      |
| tion--network-vces-vce--vnf-id--port |                                      |
| -groups-port-group--interface-id--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns cvlan-tags                   |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags <#operation--network-vces-vce--v |                                      |
| nf-id--port-groups-port-group--inter |                                      |
| face-id--cvlan-tags-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns cvlan-tag-entry              |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags/cvlan-tag-entry/{cvlan-tag} <#op |                                      |
| eration--network-vces-vce--vnf-id--p |                                      |
| ort-groups-port-group--interface-id- |                                      |
| -cvlan-tags-cvlan-tag-entry--cvlan-t |                                      |
| ag--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vces/vce/{vnf-id}/port-grou | cvlan-tag-entry                      |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags/cvlan-tag-entry/{cvlan-tag} <#op |                                      |
| eration--network-vces-vce--vnf-id--p |                                      |
| ort-groups-port-group--interface-id- |                                      |
| -cvlan-tags-cvlan-tag-entry--cvlan-t |                                      |
| ag--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing cvlan-tag-entry   |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags/cvlan-tag-entry/{cvlan-tag} <#op |                                      |
| eration--network-vces-vce--vnf-id--p |                                      |
| ort-groups-port-group--interface-id- |                                      |
| -cvlan-tags-cvlan-tag-entry--cvlan-t |                                      |
| ag--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vces/vce/{vnf-id}/port-grou | relationships                        |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags/cvlan-tag-entry/{cvlan-tag}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-vces-vce--vnf-id--port-g |                                      |
| roups-port-group--interface-id--cvla |                                      |
| n-tags-cvlan-tag-entry--cvlan-tag--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id}/cvlan-t |                                      |
| ags/cvlan-tag-entry/{cvlan-tag}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-vces-vce--vnf-id--port-g |                                      |
| roups-port-group--interface-id--cvla |                                      |
| n-tags-cvlan-tag-entry--cvlan-tag--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vces/vce/{vnf-id}/port-grou | relationships                        |
| ps/port-group/{interface-id}/relatio |                                      |
| nship-list/relationship <#operation- |                                      |
| -network-vces-vce--vnf-id--port-grou |                                      |
| ps-port-group--interface-id--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vces/vce/{vnf-id}/port-grou |                                      |
| ps/port-group/{interface-id}/relatio |                                      |
| nship-list/relationship <#operation- |                                      |
| -network-vces-vce--vnf-id--port-grou |                                      |
| ps-port-group--interface-id--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vces/vce/{vnf-id}/relations | relationships                        |
| hip-list/relationship <#operation--n |                                      |
| etwork-vces-vce--vnf-id--relationshi |                                      |
| p-list-relationship-put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vces/vce/{vnf-id}/relations |                                      |
| hip-list/relationship <#operation--n |                                      |
| etwork-vces-vce--vnf-id--relationshi |                                      |
| p-list-relationship-delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vnfcs                        |
| /network/vnfcs <#operation--network- |                                      |
| vnfcs-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vnfc                         |
| /network/vnfcs/vnfc/{vnfc-name} <#op |                                      |
| eration--network-vnfcs-vnfc--vnfc-na |                                      |
| me--get>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vnfc    |
| /network/vnfcs/vnfc/{vnfc-name} <#op |                                      |
| eration--network-vnfcs-vnfc--vnfc-na |                                      |
| me--put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vnfc              |
| /network/vnfcs/vnfc/{vnfc-name} <#op |                                      |
| eration--network-vnfcs-vnfc--vnfc-na |                                      |
| me--delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv4-address-list       |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv4-address-list       |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv4-address-list       |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv4-address-list--l3-interface- |                                      |
| ipv4-address--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | relationships                        |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| nfcs-vnfc--vnfc-name--l3-interface-i |                                      |
| pv4-address-list--l3-interface-ipv4- |                                      |
| address--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i |                                      |
| nterface-ipv4-address-list/{l3-inter |                                      |
| face-ipv4-address}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| nfcs-vnfc--vnfc-name--l3-interface-i |                                      |
| pv4-address-list--l3-interface-ipv4- |                                      |
| address--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv6-address-list       |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv6-address-list       |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | l3-interface-ipv6-address-list       |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address} <#operation--netw |                                      |
| ork-vnfcs-vnfc--vnfc-name--l3-interf |                                      |
| ace-ipv6-address-list--l3-interface- |                                      |
| ipv6-address--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i | relationships                        |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| nfcs-vnfc--vnfc-name--l3-interface-i |                                      |
| pv6-address-list--l3-interface-ipv6- |                                      |
| address--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vnfcs/vnfc/{vnfc-name}/l3-i |                                      |
| nterface-ipv6-address-list/{l3-inter |                                      |
| face-ipv6-address}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| nfcs-vnfc--vnfc-name--l3-interface-i |                                      |
| pv6-address-list--l3-interface-ipv6- |                                      |
| address--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vnfcs/vnfc/{vnfc-name}/rela | relationships                        |
| tionship-list/relationship <#operati |                                      |
| on--network-vnfcs-vnfc--vnfc-name--r |                                      |
| elationship-list-relationship-put>`_ |                                      |
| _                                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vnfcs/vnfc/{vnfc-name}/rela |                                      |
| tionship-list/relationship <#operati |                                      |
| on--network-vnfcs-vnfc--vnfc-name--r |                                      |
| elationship-list-relationship-delete |                                      |
| >`__                                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vpls-pes                     |
| /network/vpls-pes <#operation--netwo |                                      |
| rk-vpls-pes-get>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vpls-pe                      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name} <#operation--network-vpls-pes |                                      |
| -vpls-pe--equipment-name--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vpls-pe |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name} <#operation--network-vpls-pes |                                      |
| -vpls-pe--equipment-name--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vpls-pe           |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name} <#operation--network-vpls-pes |                                      |
| -vpls-pe--equipment-name--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interfaces               |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces <#operation--n |                                      |
| etwork-vpls-pes-vpls-pe--equipment-n |                                      |
| ame--lag-interfaces-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns lag-interface                |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-vpls-pes-vpls-pe--equipment-name-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--get>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | lag-interface                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-vpls-pes-vpls-pe--equipment-name-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing lag-interface     |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name} <#operation--networ |                                      |
| k-vpls-pes-vpls-pe--equipment-name-- |                                      |
| lag-interfaces-lag-interface--interf |                                      |
| ace-name--delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces <#oper |                                      |
| ation--network-vpls-pes-vpls-pe--equ |                                      |
| ipment-name--lag-interfaces-lag-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-vpls-pes-vpls-pe--equipment- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l-interface                          |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-vpls-pes-vpls-pe--equipment- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name} <#operation-- |                                      |
| network-vpls-pes-vpls-pe--equipment- |                                      |
| name--lag-interfaces-lag-interface-- |                                      |
| interface-name--l-interfaces-l-inter |                                      |
| face--interface-name--delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv4-address-l |                                      |
| ist--l3-interface-ipv4-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-vpls-pes-v |                                      |
| pls-pe--equipment-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv4-address-list/{l3-interface-ipv4 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-vpls-pes-v |                                      |
| pls-pe--equipment-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv4-address-list-- |                                      |
| l3-interface-ipv4-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--get> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address} <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--l3-interface-ipv6-address-l |                                      |
| ist--l3-interface-ipv6-address--dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-vpls-pes-v |                                      |
| pls-pe--equipment-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-put>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/l3-interface- |                                      |
| ipv6-address-list/{l3-interface-ipv6 |                                      |
| -address}/relationship-list/relation |                                      |
| ship <#operation--network-vpls-pes-v |                                      |
| pls-pe--equipment-name--lag-interfac |                                      |
| es-lag-interface--interface-name--l- |                                      |
| interfaces-l-interface--interface-na |                                      |
| me--l3-interface-ipv6-address-list-- |                                      |
| l3-interface-ipv6-address--relations |                                      |
| hip-list-relationship-delete>`__     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/relationship- |                                      |
| list/relationship <#operation--netwo |                                      |
| rk-vpls-pes-vpls-pe--equipment-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-put>`__                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/relationship- |                                      |
| list/relationship <#operation--netwo |                                      |
| rk-vpls-pes-vpls-pe--equipment-name- |                                      |
| -lag-interfaces-lag-interface--inter |                                      |
| face-name--l-interfaces-l-interface- |                                      |
| -interface-name--relationship-list-r |                                      |
| elationship-delete>`__               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs <#o |                                      |
| peration--network-vpls-pes-vpls-pe-- |                                      |
| equipment-name--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--srio |                                      |
| v-vfs-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | sriov-vf                             |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--sriov-vfs-sriov-vf--pc |                                      |
| i-id--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id}/relationship-list/rel |                                      |
| ationship <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/sriov-vfs/sri |                                      |
| ov-vf/{pci-id}/relationship-list/rel |                                      |
| ationship <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--sriov-vfs-sriov-vf--pci-id- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--lag-interfaces-lag-inter |                                      |
| face--interface-name--l-interfaces-l |                                      |
| -interface--interface-name--vlans-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface} <#operation--network- |                                      |
| vpls-pes-vpls-pe--equipment-name--la |                                      |
| g-interfaces-lag-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--vlans-vlan--vlan-inter |                                      |
| face--delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv4-address-list--l3-interfac |                                      |
| e-ipv4-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-vpls-pes-vpls-pe-- |                                      |
| equipment-name--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv4-add |                                      |
| ress-list/{l3-interface-ipv4-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-vpls-pes-vpls-pe-- |                                      |
| equipment-name--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv4-address-list--l3-interface-ipv |                                      |
| 4-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| } <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--lag-interfaces- |                                      |
| lag-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--l3-inte |                                      |
| rface-ipv6-address-list--l3-interfac |                                      |
| e-ipv6-address--delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-vpls-pes-vpls-pe-- |                                      |
| equipment-name--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-put>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/l3-interface-ipv6-add |                                      |
| ress-list/{l3-interface-ipv6-address |                                      |
| }/relationship-list/relationship <#o |                                      |
| peration--network-vpls-pes-vpls-pe-- |                                      |
| equipment-name--lag-interfaces-lag-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--vlan |                                      |
| s-vlan--vlan-interface--l3-interface |                                      |
| -ipv6-address-list--l3-interface-ipv |                                      |
| 6-address--relationship-list-relatio |                                      |
| nship-delete>`__                     |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/relationship-list/rel |                                      |
| ationship <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-put> |                                      |
| `__                                  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/l-interfaces/l-inte |                                      |
| rface/{interface-name}/vlans/vlan/{v |                                      |
| lan-interface}/relationship-list/rel |                                      |
| ationship <#operation--network-vpls- |                                      |
| pes-vpls-pe--equipment-name--lag-int |                                      |
| erfaces-lag-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--vlans-vlan--vlan-interface- |                                      |
| -relationship-list-relationship-dele |                                      |
| te>`__                               |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/relationship-list/r |                                      |
| elationship <#operation--network-vpl |                                      |
| s-pes-vpls-pe--equipment-name--lag-i |                                      |
| nterfaces-lag-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/lag-interfaces/lag-interface/ |                                      |
| {interface-name}/relationship-list/r |                                      |
| elationship <#operation--network-vpl |                                      |
| s-pes-vpls-pe--equipment-name--lag-i |                                      |
| nterfaces-lag-interface--interface-n |                                      |
| ame--relationship-list-relationship- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interfaces                 |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces <#operation--net |                                      |
| work-vpls-pes-vpls-pe--equipment-nam |                                      |
| e--p-interfaces-get>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns p-interface                  |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name} <#operation--network-vp |                                      |
| ls-pes-vpls-pe--equipment-name--p-in |                                      |
| terfaces-p-interface--interface-name |                                      |
| --get>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | p-interface                          |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name} <#operation--network-vp |                                      |
| ls-pes-vpls-pe--equipment-name--p-in |                                      |
| terfaces-p-interface--interface-name |                                      |
| --put>`__                            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing p-interface       |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name} <#operation--network-vp |                                      |
| ls-pes-vpls-pe--equipment-name--p-in |                                      |
| terfaces-p-interface--interface-name |                                      |
| --delete>`__                         |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interfaces                 |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces <#operatio |                                      |
| n--network-vpls-pes-vpls-pe--equipme |                                      |
| nt-name--p-interfaces-p-interface--i |                                      |
| nterface-name--l-interfaces-get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns l-interface                  |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name} <#operation--netw |                                      |
| ork-vpls-pes-vpls-pe--equipment-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--get>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l-interface                          |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name} <#operation--netw |                                      |
| ork-vpls-pes-vpls-pe--equipment-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing l-interface       |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name} <#operation--netw |                                      |
| ork-vpls-pes-vpls-pe--equipment-name |                                      |
| --p-interfaces-p-interface--interfac |                                      |
| e-name--l-interfaces-l-interface--in |                                      |
| terface-name--delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv4 |                                      |
| -address-list/{l3-interface-ipv4-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv4 |                                      |
| -address-list/{l3-interface-ipv4-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv4 |                                      |
| -address-list/{l3-interface-ipv4-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv4-address-list--l3- |                                      |
| interface-ipv4-address--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv4 |                                      |
| -address-list/{l3-interface-ipv4-add |                                      |
| ress}/relationship-list/relationship |                                      |
|  <#operation--network-vpls-pes-vpls- |                                      |
| pe--equipment-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--l3-i |                                      |
| nterface-ipv4-address-list--l3-inter |                                      |
| face-ipv4-address--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv4 |                                      |
| -address-list/{l3-interface-ipv4-add |                                      |
| ress}/relationship-list/relationship |                                      |
|  <#operation--network-vpls-pes-vpls- |                                      |
| pe--equipment-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--l3-i |                                      |
| nterface-ipv4-address-list--l3-inter |                                      |
| face-ipv4-address--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv6 |                                      |
| -address-list/{l3-interface-ipv6-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--get>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv6 |                                      |
| -address-list/{l3-interface-ipv6-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv6 |                                      |
| -address-list/{l3-interface-ipv6-add |                                      |
| ress} <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -l3-interface-ipv6-address-list--l3- |                                      |
| interface-ipv6-address--delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv6 |                                      |
| -address-list/{l3-interface-ipv6-add |                                      |
| ress}/relationship-list/relationship |                                      |
|  <#operation--network-vpls-pes-vpls- |                                      |
| pe--equipment-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--l3-i |                                      |
| nterface-ipv6-address-list--l3-inter |                                      |
| face-ipv6-address--relationship-list |                                      |
| -relationship-put>`__                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/l3-interface-ipv6 |                                      |
| -address-list/{l3-interface-ipv6-add |                                      |
| ress}/relationship-list/relationship |                                      |
|  <#operation--network-vpls-pes-vpls- |                                      |
| pe--equipment-name--p-interfaces-p-i |                                      |
| nterface--interface-name--l-interfac |                                      |
| es-l-interface--interface-name--l3-i |                                      |
| nterface-ipv6-address-list--l3-inter |                                      |
| face-ipv6-address--relationship-list |                                      |
| -relationship-delete>`__             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| pls-pes-vpls-pe--equipment-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--relationship-list-relations |                                      |
| hip-put>`__                          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/relationship-list |                                      |
| /relationship <#operation--network-v |                                      |
| pls-pes-vpls-pe--equipment-name--p-i |                                      |
| nterfaces-p-interface--interface-nam |                                      |
| e--l-interfaces-l-interface--interfa |                                      |
| ce-name--relationship-list-relations |                                      |
| hip-delete>`__                       |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vfs                    |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--p-interfaces-p-interface |                                      |
| --interface-name--l-interfaces-l-int |                                      |
| erface--interface-name--sriov-vfs-ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-vf                     |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs/sriov-v |                                      |
| f/{pci-id} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--sriov-vfs-sriov-vf--pci-id--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | sriov-vf                             |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs/sriov-v |                                      |
| f/{pci-id} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--sriov-vfs-sriov-vf--pci-id--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-vf          |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs/sriov-v |                                      |
| f/{pci-id} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--sriov-vfs-sriov-vf--pci-id--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs/sriov-v |                                      |
| f/{pci-id}/relationship-list/relatio |                                      |
| nship <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -sriov-vfs-sriov-vf--pci-id--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/sriov-vfs/sriov-v |                                      |
| f/{pci-id}/relationship-list/relatio |                                      |
| nship <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -sriov-vfs-sriov-vf--pci-id--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlans                        |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans <#operation |                                      |
| --network-vpls-pes-vpls-pe--equipmen |                                      |
| t-name--p-interfaces-p-interface--in |                                      |
| terface-name--l-interfaces-l-interfa |                                      |
| ce--interface-name--vlans-get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vlan                         |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--vlans-vlan--vlan-interface--ge |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing vlan    |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--vlans-vlan--vlan-interface--pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vlan              |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface} <#operation--network-vpls |                                      |
| -pes-vpls-pe--equipment-name--p-inte |                                      |
| rfaces-p-interface--interface-name-- |                                      |
| l-interfaces-l-interface--interface- |                                      |
| name--vlans-vlan--vlan-interface--de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv4-address |                                      |
| -list/{l3-interface-ipv4-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v4-address-list--l3-interface-ipv4-a |                                      |
| ddress--get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv4-address |                                      |
| -list/{l3-interface-ipv4-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v4-address-list--l3-interface-ipv4-a |                                      |
| ddress--put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv4-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv4-address |                                      |
| -list/{l3-interface-ipv4-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v4-address-list--l3-interface-ipv4-a |                                      |
| ddress--delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv4-address |                                      |
| -list/{l3-interface-ipv4-address}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--p-interfaces-p-interface |                                      |
| --interface-name--l-interfaces-l-int |                                      |
| erface--interface-name--vlans-vlan-- |                                      |
| vlan-interface--l3-interface-ipv4-ad |                                      |
| dress-list--l3-interface-ipv4-addres |                                      |
| s--relationship-list-relationship-pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv4-address |                                      |
| -list/{l3-interface-ipv4-address}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--p-interfaces-p-interface |                                      |
| --interface-name--l-interfaces-l-int |                                      |
| erface--interface-name--vlans-vlan-- |                                      |
| vlan-interface--l3-interface-ipv4-ad |                                      |
| dress-list--l3-interface-ipv4-addres |                                      |
| s--relationship-list-relationship-de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns                              |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv6-address |                                      |
| -list/{l3-interface-ipv6-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v6-address-list--l3-interface-ipv6-a |                                      |
| ddress--get>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv6-address |                                      |
| -list/{l3-interface-ipv6-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v6-address-list--l3-interface-ipv6-a |                                      |
| ddress--put>`__                      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing                   |
| /network/vpls-pes/vpls-pe/{equipment | l3-interface-ipv6-address-list       |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv6-address |                                      |
| -list/{l3-interface-ipv6-address} <# |                                      |
| operation--network-vpls-pes-vpls-pe- |                                      |
| -equipment-name--p-interfaces-p-inte |                                      |
| rface--interface-name--l-interfaces- |                                      |
| l-interface--interface-name--vlans-v |                                      |
| lan--vlan-interface--l3-interface-ip |                                      |
| v6-address-list--l3-interface-ipv6-a |                                      |
| ddress--delete>`__                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv6-address |                                      |
| -list/{l3-interface-ipv6-address}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--p-interfaces-p-interface |                                      |
| --interface-name--l-interfaces-l-int |                                      |
| erface--interface-name--vlans-vlan-- |                                      |
| vlan-interface--l3-interface-ipv6-ad |                                      |
| dress-list--l3-interface-ipv6-addres |                                      |
| s--relationship-list-relationship-pu |                                      |
| t>`__                                |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/l3-interface-ipv6-address |                                      |
| -list/{l3-interface-ipv6-address}/re |                                      |
| lationship-list/relationship <#opera |                                      |
| tion--network-vpls-pes-vpls-pe--equi |                                      |
| pment-name--p-interfaces-p-interface |                                      |
| --interface-name--l-interfaces-l-int |                                      |
| erface--interface-name--vlans-vlan-- |                                      |
| vlan-interface--l3-interface-ipv6-ad |                                      |
| dress-list--l3-interface-ipv6-addres |                                      |
| s--relationship-list-relationship-de |                                      |
| lete>`__                             |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/relationship-list/relatio |                                      |
| nship <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--relatio |                                      |
| nship-list-relationship-put>`__      |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/l-interfaces/l-interfac |                                      |
| e/{interface-name}/vlans/vlan/{vlan- |                                      |
| interface}/relationship-list/relatio |                                      |
| nship <#operation--network-vpls-pes- |                                      |
| vpls-pe--equipment-name--p-interface |                                      |
| s-p-interface--interface-name--l-int |                                      |
| erfaces-l-interface--interface-name- |                                      |
| -vlans-vlan--vlan-interface--relatio |                                      |
| nship-list-relationship-delete>`__   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/relationship-list/relat |                                      |
| ionship <#operation--network-vpls-pe |                                      |
| s-vpls-pe--equipment-name--p-interfa |                                      |
| ces-p-interface--interface-name--rel |                                      |
| ationship-list-relationship-put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/relationship-list/relat |                                      |
| ionship <#operation--network-vpls-pe |                                      |
| s-vpls-pe--equipment-name--p-interfa |                                      |
| ces-p-interface--interface-name--rel |                                      |
| ationship-list-relationship-delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pfs                    |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs <#operation-- |                                      |
| network-vpls-pes-vpls-pe--equipment- |                                      |
| name--p-interfaces-p-interface--inte |                                      |
| rface-name--sriov-pfs-get>`__        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns sriov-pf                     |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs/sriov-pf/{pf- |                                      |
| pci-id} <#operation--network-vpls-pe |                                      |
| s-vpls-pe--equipment-name--p-interfa |                                      |
| ces-p-interface--interface-name--sri |                                      |
| ov-pfs-sriov-pf--pf-pci-id--get>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpls-pes/vpls-pe/{equipment | sriov-pf                             |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs/sriov-pf/{pf- |                                      |
| pci-id} <#operation--network-vpls-pe |                                      |
| s-vpls-pe--equipment-name--p-interfa |                                      |
| ces-p-interface--interface-name--sri |                                      |
| ov-pfs-sriov-pf--pf-pci-id--put>`__  |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing sriov-pf          |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs/sriov-pf/{pf- |                                      |
| pci-id} <#operation--network-vpls-pe |                                      |
| s-vpls-pe--equipment-name--p-interfa |                                      |
| ces-p-interface--interface-name--sri |                                      |
| ov-pfs-sriov-pf--pf-pci-id--delete>` |                                      |
| __                                   |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs/sriov-pf/{pf- |                                      |
| pci-id}/relationship-list/relationsh |                                      |
| ip <#operation--network-vpls-pes-vpl |                                      |
| s-pe--equipment-name--p-interfaces-p |                                      |
| -interface--interface-name--sriov-pf |                                      |
| s-sriov-pf--pf-pci-id--relationship- |                                      |
| list-relationship-put>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/p-interfaces/p-interface/{int |                                      |
| erface-name}/sriov-pfs/sriov-pf/{pf- |                                      |
| pci-id}/relationship-list/relationsh |                                      |
| ip <#operation--network-vpls-pes-vpl |                                      |
| s-pe--equipment-name--p-interfaces-p |                                      |
| -interface--interface-name--sriov-pf |                                      |
| s-sriov-pf--pf-pci-id--relationship- |                                      |
| list-relationship-delete>`__         |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpls-pes/vpls-pe/{equipment | relationships                        |
| -name}/relationship-list/relationshi |                                      |
| p <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpls-pes/vpls-pe/{equipment |                                      |
| -name}/relationship-list/relationshi |                                      |
| p <#operation--network-vpls-pes-vpls |                                      |
| -pe--equipment-name--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vpn-bindings                 |
| /network/vpn-bindings <#operation--n |                                      |
| etwork-vpn-bindings-get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns vpn-binding                  |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id} <#operation--network-vpn-bind |                                      |
| ings-vpn-binding--vpn-id--get>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpn-bindings/vpn-binding/{v | vpn-binding                          |
| pn-id} <#operation--network-vpn-bind |                                      |
| ings-vpn-binding--vpn-id--put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing vpn-binding       |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id} <#operation--network-vpn-bind |                                      |
| ings-vpn-binding--vpn-id--delete>`__ |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpn-bindings/vpn-binding/{v | relationships                        |
| pn-id}/relationship-list/relationshi |                                      |
| p <#operation--network-vpn-bindings- |                                      |
| vpn-binding--vpn-id--relationship-li |                                      |
| st-relationship-put>`__              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id}/relationship-list/relationshi |                                      |
| p <#operation--network-vpn-bindings- |                                      |
| vpn-binding--vpn-id--relationship-li |                                      |
| st-relationship-delete>`__           |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns route-targets                |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id}/route-targets <#operation--ne |                                      |
| twork-vpn-bindings-vpn-binding--vpn- |                                      |
| id--route-targets-get>`__            |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns route-target                 |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id}/route-targets/route-target/{g |                                      |
| lobal-route-target}/{route-target-ro |                                      |
| le} <#operation--network-vpn-binding |                                      |
| s-vpn-binding--vpn-id--route-targets |                                      |
| -route-target--global-route-target-- |                                      |
| -route-target-role--get>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing         |
| /network/vpn-bindings/vpn-binding/{v | route-target                         |
| pn-id}/route-targets/route-target/{g |                                      |
| lobal-route-target}/{route-target-ro |                                      |
| le} <#operation--network-vpn-binding |                                      |
| s-vpn-binding--vpn-id--route-targets |                                      |
| -route-target--global-route-target-- |                                      |
| -route-target-role--put>`__          |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing route-target      |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id}/route-targets/route-target/{g |                                      |
| lobal-route-target}/{route-target-ro |                                      |
| le} <#operation--network-vpn-binding |                                      |
| s-vpn-binding--vpn-id--route-targets |                                      |
| -route-target--global-route-target-- |                                      |
| -route-target-role--delete>`__       |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/vpn-bindings/vpn-binding/{v | relationships                        |
| pn-id}/route-targets/route-target/{g |                                      |
| lobal-route-target}/{route-target-ro |                                      |
| le}/relationship-list/relationship < |                                      |
| #operation--network-vpn-bindings-vpn |                                      |
| -binding--vpn-id--route-targets-rout |                                      |
| e-target--global-route-target---rout |                                      |
| e-target-role--relationship-list-rel |                                      |
| ationship-put>`__                    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/vpn-bindings/vpn-binding/{v |                                      |
| pn-id}/route-targets/route-target/{g |                                      |
| lobal-route-target}/{route-target-ro |                                      |
| le}/relationship-list/relationship < |                                      |
| #operation--network-vpn-bindings-vpn |                                      |
| -binding--vpn-id--route-targets-rout |                                      |
| e-target--global-route-target---rout |                                      |
| e-target-role--relationship-list-rel |                                      |
| ationship-delete>`__                 |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns zones                        |
| /network/zones <#operation--network- |                                      |
| zones-get>`__                        |                                      |
+--------------------------------------+--------------------------------------+
| `GET                                 | returns zone                         |
| /network/zones/zone/{zone-id} <#oper |                                      |
| ation--network-zones-zone--zone-id-- |                                      |
| get>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | create or update an existing zone    |
| /network/zones/zone/{zone-id} <#oper |                                      |
| ation--network-zones-zone--zone-id-- |                                      |
| put>`__                              |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing zone              |
| /network/zones/zone/{zone-id} <#oper |                                      |
| ation--network-zones-zone--zone-id-- |                                      |
| delete>`__                           |                                      |
+--------------------------------------+--------------------------------------+
| `PUT                                 | see node definition for valid        |
| /network/zones/zone/{zone-id}/relati | relationships                        |
| onship-list/relationship <#operation |                                      |
| --network-zones-zone--zone-id--relat |                                      |
| ionship-list-relationship-put>`__    |                                      |
+--------------------------------------+--------------------------------------+
| `DELETE                              | delete an existing relationship      |
| /network/zones/zone/{zone-id}/relati |                                      |
| onship-list/relationship <#operation |                                      |
| --network-zones-zone--zone-id--relat |                                      |
| ionship-list-relationship-delete>`__ |                                      |
+--------------------------------------+--------------------------------------+

.. rubric:: Paths
   :name: paths

.. raw:: html

   <div id="operation--business-connectors-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns connectors

.. raw:: html

   </div>

.. rubric:: GET **/business/connectors**
   :name: get-businessconnectors
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns connectors

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/connectors <#/definitions/connectors>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns connector

.. raw:: html

   </div>

.. rubric:: GET
   **/business/connectors/connector/{resource-instance-id}**
   :name: get-businessconnectorsconnectorresource-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns connector

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/connector <#/definitions/connector>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing connector

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/connectors/connector/{resource-instance-id}**
   :name: put-businessconnectorsconnectorresource-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing connector

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

connector object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/connector <#/definitions/connector>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing connector

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/connectors/connector/{resource-instance-id}**
   :name: delete-businessconnectorsconnectorresource-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing connector

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--metadata-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadata

.. raw:: html

   </div>

.. rubric:: GET
   **/business/connectors/connector/{resource-instance-id}/metadata**
   :name: get-businessconnectorsconnectorresource-instance-idmetadata
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadata

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadata <#/definitions/metadata>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadatum

.. raw:: html

   </div>

.. rubric:: GET
   **/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}**
   :name: get-businessconnectorsconnectorresource-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadatum <#/definitions/metadatum>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing metadatum

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}**
   :name: put-businessconnectorsconnectorresource-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

metadatum object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/metadatum <#/definitions/metadatum>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--metadata-metadatum--metaname--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing metadatum

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}**
   :name: delete-businessconnectorsconnectorresource-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/connectors/connector/{resource-instance-id}/relationship-list/relationship**
   :name: put-businessconnectorsconnectorresource-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-connectors-connector--resource-instance-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/connectors/connector/{resource-instance-id}/relationship-list/relationship**
   :name: delete-businessconnectorsconnectorresource-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| resource-insta | Unique id of   | path           | string         |                |
| nce-id         | resource       |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-customers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns customers

.. raw:: html

   </div>

.. rubric:: GET **/business/customers**
   :name: get-businesscustomers
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns customers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/customers <#/definitions/customers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns customer

.. raw:: html

   </div>

.. rubric:: GET **/business/customers/customer/{global-customer-id}**
   :name: get-businesscustomerscustomerglobal-customer-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns customer

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/customer <#/definitions/customer>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing customer

.. raw:: html

   </div>

.. rubric:: PUT **/business/customers/customer/{global-customer-id}**
   :name: put-businesscustomerscustomerglobal-customer-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing customer

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

customer object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/customer <#/definitions/customer>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing customer

.. raw:: html

   </div>

.. rubric:: DELETE **/business/customers/customer/{global-customer-id}**
   :name: delete-businesscustomerscustomerglobal-customer-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing customer

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/relationship-list/relationship**
   :name: put-businesscustomerscustomerglobal-customer-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/relationship-list/relationship**
   :name: delete-businesscustomerscustomerglobal-customer-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-subscriptions

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptions
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-subscriptions

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-subscriptions <#/definitions/service-subscriptions>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-subscription

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-type
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-subscription

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-subscription <#/definitions/service-subscription>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing service-subscription

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-type
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing service-subscription

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

service-subscription object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/service-subscription <#/definitions/service-subscription>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing service-subscription

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-type
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing service-subscription

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/relationship-list/relationship**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-instances

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instances
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-instances

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-instances <#/definitions/service-instances>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-instance

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-instance <#/definitions/service-instance>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing service-instance

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

service-instance object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/service-instance <#/definitions/service-instance>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing service-instance

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns allotted-resources

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resources
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns allotted-resources

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/allotted-resources <#/definitions/allotted-resources>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns allotted-resource

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| type           | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of    |                |                |                |
|                | allotted       |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| role           | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this resource  |                |                |                |
|                | will be        |                |                |                |
|                | providing.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/allotted-resource <#/definitions/allotted-resource>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing allotted-resource

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

allotted-resource object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/allotted-resource <#/definitions/allotted-resource>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--allotted-resources-allotted-resource--id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing allotted-resource

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/allotted-resources/allotted-resource/{id}**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns tunnel-xconnects

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnects
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns tunnel-xconnects

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| type           | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of    |                |                |                |
|                | allotted       |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| role           | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this resource  |                |                |                |
|                | will be        |                |                |                |
|                | providing.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/tunnel-xconnects <#/definitions/tunnel-xconnects>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns tunnel-xconnect

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnectstunnel-xconnectid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns tunnel-xconnect

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| type           | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of    |                |                |                |
|                | allotted       |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| role           | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this resource  |                |                |                |
|                | will be        |                |                |                |
|                | providing.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/tunnel-xconnect <#/definitions/tunnel-xconnect>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing tunnel-xconnect

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnectstunnel-xconnectid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing tunnel-xconnect

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

tunnel-xconnect object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/tunnel-xconnect <#/definitions/tunnel-xconnect>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing tunnel-xconnect

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnectstunnel-xconnectid
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing tunnel-xconnect

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnectstunnel-xconnectidrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idallotted-resourcesallotted-resourceidtunnel-xconnectstunnel-xconnectidrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| id             | Allotted       | path           | string         |                |
|                | Resource id    |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadata

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idmetadata
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadata

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadata <#/definitions/metadata>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadatum

.. raw:: html

   </div>

.. rubric:: GET
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}**
   :name: get-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-nam | Subscriber     | query          | string         |                |
| e              | name, an       |                |                |                |
|                | alternate way  |                |                |                |
|                | to retrieve a  |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subscriber-typ | Subscriber     | query          | string         |                |
| e              | type, a way to |                |                |                |
|                | provide VID    |                |                |                |
|                | with only the  |                |                |                |
|                | INFRA          |                |                |                |
|                | customers.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | This field     | query          | string         |                |
| ce-name        | will store a   |                |                |                |
|                | name assigned  |                |                |                |
|                | to the         |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| environment-co | This field     | query          | string         |                |
| ntext          | will store the |                |                |                |
|                | environment    |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| workload-conte | This field     | query          | string         |                |
| xt             | will store the |                |                |                |
|                | workload       |                |                |                |
|                | context        |                |                |                |
|                | assigned to    |                |                |                |
|                | the            |                |                |                |
|                | service-instan |                |                |                |
|                | ce.            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | An identifier  | query          | string         |                |
| ce-location-id | that customers |                |                |                |
|                | assign to the  |                |                |                |
|                | location where |                |                |                |
|                | this service   |                |                |                |
|                | is being used. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| orchestration- | Orchestration  | query          | string         |                |
| status         | status of this |                |                |                |
|                | service.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadatum <#/definitions/metadatum>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing metadatum

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

metadatum object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/metadatum <#/definitions/metadatum>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--metadata-metadatum--metaname--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing metadatum

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idmetadatametadatummetaname
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship**
   :name: put-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-customers-customer--global-customer-id--service-subscriptions-service-subscription--service-type--service-instances-service-instance--service-instance-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship**
   :name: delete-businesscustomerscustomerglobal-customer-idservice-subscriptionsservice-subscriptionservice-typeservice-instancesservice-instanceservice-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| global-custome | Global         | path           | string         |                |
| r-id           | customer id    |                |                |                |
|                | used across    |                |                |                |
|                | ECOMP to       |                |                |                |
|                | uniquely       |                |                |                |
|                | identify       |                |                |                |
|                | customer.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-type   | Value defined  | path           | string         |                |
|                | by             |                |                |                |
|                | orchestration  |                |                |                |
|                | to identify    |                |                |                |
|                | this service   |                |                |                |
|                | across ECOMP.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-instan | Uniquely       | path           | string         |                |
| ce-id          | identifies     |                |                |                |
|                | this instance  |                |                |                |
|                | of a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-lines-of-business-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lines-of-business

.. raw:: html

   </div>

.. rubric:: GET **/business/lines-of-business**
   :name: get-businesslines-of-business
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lines-of-business

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lines-of-business <#/definitions/lines-of-business>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-lines-of-business-line-of-business--line-of-business-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns line-of-business

.. raw:: html

   </div>

.. rubric:: GET
   **/business/lines-of-business/line-of-business/{line-of-business-name}**
   :name: get-businesslines-of-businessline-of-businessline-of-business-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns line-of-business

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| line-of-busine | Name of the    | path           | string         |                |
| ss-name        | line-of-busine |                |                |                |
|                | ss             |                |                |                |
|                | (product)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/line-of-business <#/definitions/line-of-business>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-lines-of-business-line-of-business--line-of-business-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing line-of-business

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/lines-of-business/line-of-business/{line-of-business-name}**
   :name: put-businesslines-of-businessline-of-businessline-of-business-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing line-of-business

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

line-of-business object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/line-of-business <#/definitions/line-of-business>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| line-of-busine | Name of the    | path           | string         |                |
| ss-name        | line-of-busine |                |                |                |
|                | ss             |                |                |                |
|                | (product)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-lines-of-business-line-of-business--line-of-business-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing line-of-business

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/lines-of-business/line-of-business/{line-of-business-name}**
   :name: delete-businesslines-of-businessline-of-businessline-of-business-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing line-of-business

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| line-of-busine | Name of the    | path           | string         |                |
| ss-name        | line-of-busine |                |                |                |
|                | ss             |                |                |                |
|                | (product)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship**
   :name: put-businesslines-of-businessline-of-businessline-of-business-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| line-of-busine | Name of the    | path           | string         |                |
| ss-name        | line-of-busine |                |                |                |
|                | ss             |                |                |                |
|                | (product)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-lines-of-business-line-of-business--line-of-business-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/lines-of-business/line-of-business/{line-of-business-name}/relationship-list/relationship**
   :name: delete-businesslines-of-businessline-of-businessline-of-business-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| line-of-busine | Name of the    | path           | string         |                |
| ss-name        | line-of-busine |                |                |                |
|                | ss             |                |                |                |
|                | (product)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-owning-entities-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns owning-entities

.. raw:: html

   </div>

.. rubric:: GET **/business/owning-entities**
   :name: get-businessowning-entities
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns owning-entities

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/owning-entities <#/definitions/owning-entities>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-owning-entities-owning-entity--owning-entity-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns owning-entity

.. raw:: html

   </div>

.. rubric:: GET
   **/business/owning-entities/owning-entity/{owning-entity-id}**
   :name: get-businessowning-entitiesowning-entityowning-entity-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns owning-entity

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| owning-entity- | UUID of an     | path           | string         |                |
| id             | owning entity  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/owning-entity <#/definitions/owning-entity>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-owning-entities-owning-entity--owning-entity-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing owning-entity

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/owning-entities/owning-entity/{owning-entity-id}**
   :name: put-businessowning-entitiesowning-entityowning-entity-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing owning-entity

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

owning-entity object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/owning-entity <#/definitions/owning-entity>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| owning-entity- | UUID of an     | path           | string         |                |
| id             | owning entity  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-owning-entities-owning-entity--owning-entity-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing owning-entity

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/owning-entities/owning-entity/{owning-entity-id}**
   :name: delete-businessowning-entitiesowning-entityowning-entity-id
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing owning-entity

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| owning-entity- | UUID of an     | path           | string         |                |
| id             | owning entity  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship**
   :name: put-businessowning-entitiesowning-entityowning-entity-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| owning-entity- | UUID of an     | path           | string         |                |
| id             | owning entity  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-owning-entities-owning-entity--owning-entity-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/owning-entities/owning-entity/{owning-entity-id}/relationship-list/relationship**
   :name: delete-businessowning-entitiesowning-entityowning-entity-idrelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| owning-entity- | UUID of an     | path           | string         |                |
| id             | owning entity  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-platforms-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns platforms

.. raw:: html

   </div>

.. rubric:: GET **/business/platforms**
   :name: get-businessplatforms
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns platforms

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/platforms <#/definitions/platforms>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-platforms-platform--platform-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns platform

.. raw:: html

   </div>

.. rubric:: GET **/business/platforms/platform/{platform-name}**
   :name: get-businessplatformsplatformplatform-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns platform

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| platform-name  | Name of the    | path           | string         |                |
|                | platform       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/platform <#/definitions/platform>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-platforms-platform--platform-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing platform

.. raw:: html

   </div>

.. rubric:: PUT **/business/platforms/platform/{platform-name}**
   :name: put-businessplatformsplatformplatform-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing platform

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

platform object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/platform <#/definitions/platform>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| platform-name  | Name of the    | path           | string         |                |
|                | platform       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-platforms-platform--platform-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing platform

.. raw:: html

   </div>

.. rubric:: DELETE **/business/platforms/platform/{platform-name}**
   :name: delete-businessplatformsplatformplatform-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing platform

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| platform-name  | Name of the    | path           | string         |                |
|                | platform       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-platforms-platform--platform-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/platforms/platform/{platform-name}/relationship-list/relationship**
   :name: put-businessplatformsplatformplatform-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| platform-name  | Name of the    | path           | string         |                |
|                | platform       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-platforms-platform--platform-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/platforms/platform/{platform-name}/relationship-list/relationship**
   :name: delete-businessplatformsplatformplatform-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| platform-name  | Name of the    | path           | string         |                |
|                | platform       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-projects-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns projects

.. raw:: html

   </div>

.. rubric:: GET **/business/projects**
   :name: get-businessprojects
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns projects

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/projects <#/definitions/projects>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-projects-project--project-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns project

.. raw:: html

   </div>

.. rubric:: GET **/business/projects/project/{project-name}**
   :name: get-businessprojectsprojectproject-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns project

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| project-name   | Name of the    | path           | string         |                |
|                | project        |                |                |                |
|                | deploying a    |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/project <#/definitions/project>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-projects-project--project-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing project

.. raw:: html

   </div>

.. rubric:: PUT **/business/projects/project/{project-name}**
   :name: put-businessprojectsprojectproject-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing project

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

project object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/project <#/definitions/project>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| project-name   | Name of the    | path           | string         |                |
|                | project        |                |                |                |
|                | deploying a    |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--business-projects-project--project-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing project

.. raw:: html

   </div>

.. rubric:: DELETE **/business/projects/project/{project-name}**
   :name: delete-businessprojectsprojectproject-name
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing project

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| project-name   | Name of the    | path           | string         |                |
|                | project        |                |                |                |
|                | deploying a    |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-projects-project--project-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/business/projects/project/{project-name}/relationship-list/relationship**
   :name: put-businessprojectsprojectproject-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| project-name   | Name of the    | path           | string         |                |
|                | project        |                |                |                |
|                | deploying a    |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--business-projects-project--project-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/business/projects/project/{project-name}/relationship-list/relationship**
   :name: delete-businessprojectsprojectproject-namerelationship-listrelationship
   :class: panel-title

Tags: `Business <#tag-Business>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| project-name   | Name of the    | path           | string         |                |
|                | project        |                |                |                |
|                | deploying a    |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--cloud-infrastructure-cloud-regions-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns cloud-regions

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/cloud-regions**
   :name: get-cloud-infrastructurecloud-regions
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns cloud-regions

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/cloud-regions <#/definitions/cloud-regions>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns cloud-region

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns cloud-region

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/cloud-region <#/definitions/cloud-region>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing cloud-region

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing cloud-region

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

cloud-region object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/cloud-region <#/definitions/cloud-region>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing cloud-region

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing cloud-region

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns availability-zones

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zones
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns availability-zones

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/availability-zones <#/definitions/availability-zones>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns availability-zone

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zonesavailability-zoneavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns availability-zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone. Unique   |                |                |                |
|                | across a cloud |                |                |                |
|                | region         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/availability-zone <#/definitions/availability-zone>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing availability-zone

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zonesavailability-zoneavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing availability-zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

availability-zone object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/availability-zone <#/definitions/availability-zone>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone. Unique   |                |                |                |
|                | across a cloud |                |                |                |
|                | region         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing availability-zone

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zonesavailability-zoneavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing availability-zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone. Unique   |                |                |                |
|                | across a cloud |                |                |                |
|                | region         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zonesavailability-zoneavailability-zone-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone. Unique   |                |                |                |
|                | across a cloud |                |                |                |
|                | region         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--availability-zones-availability-zone--availability-zone-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idavailability-zonesavailability-zoneavailability-zone-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone. Unique   |                |                |                |
|                | across a cloud |                |                |                |
|                | region         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns dvs-switches

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switches
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns dvs-switches

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/dvs-switches <#/definitions/dvs-switches>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns dvs-switch

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switchesdvs-switchswitch-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns dvs-switch

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS switch     | path           | string         |                |
|                | name           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vcenter-url    | URL used to    | query          | string         |                |
|                | reach the      |                |                |                |
|                | vcenter        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/dvs-switch <#/definitions/dvs-switch>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing dvs-switch

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switchesdvs-switchswitch-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing dvs-switch

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

dvs-switch object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/dvs-switch <#/definitions/dvs-switch>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS switch     | path           | string         |                |
|                | name           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing dvs-switch

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switchesdvs-switchswitch-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing dvs-switch

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS switch     | path           | string         |                |
|                | name           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switchesdvs-switchswitch-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS switch     | path           | string         |                |
|                | name           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--dvs-switches-dvs-switch--switch-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-iddvs-switchesdvs-switchswitch-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS switch     | path           | string         |                |
|                | name           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info-list

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-list
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info-list <#/definitions/esr-system-info-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-name    | name of        | query          | string         |                |
|                | external       |                |                |                |
|                | system.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-type    | it could be    | query          | string         |                |
|                | vim/vnfm/third |                |                |                |
|                | party-sdnc/ems |                |                |                |
|                | -resource/ems- |                |                |                |
|                | performance/em |                |                |                |
|                | s-alarm.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-system-info object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-system-info <#/definitions/esr-system-info>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns flavors

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavors
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns flavors

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/flavors <#/definitions/flavors>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns flavor

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavorsflavorflavor-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns flavor

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-id      | Flavor id,     | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-name    | Flavor name    | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/flavor <#/definitions/flavor>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing flavor

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavorsflavorflavor-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing flavor

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

flavor object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/flavor <#/definitions/flavor>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-id      | Flavor id,     | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing flavor

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavorsflavorflavor-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing flavor

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-id      | Flavor id,     | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavorsflavorflavor-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-id      | Flavor id,     | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--flavors-flavor--flavor-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idflavorsflavorflavor-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| flavor-id      | Flavor id,     | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns group-assignments

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignments
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns group-assignments

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/group-assignments <#/definitions/group-assignments>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns group-assignment

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignmentsgroup-assignmentgroup-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns group-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-id       | Group id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-type     | Group type -   | query          | string         |                |
|                | the type of    |                |                |                |
|                | group this     |                |                |                |
|                | instance       |                |                |                |
|                | refers to      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-name     | Group name -   | query          | string         |                |
|                | name assigned  |                |                |                |
|                | to the group   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/group-assignment <#/definitions/group-assignment>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing group-assignment

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignmentsgroup-assignmentgroup-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing group-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

group-assignment object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/group-assignment <#/definitions/group-assignment>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-id       | Group id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing group-assignment

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignmentsgroup-assignmentgroup-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing group-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-id       | Group id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignmentsgroup-assignmentgroup-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-id       | Group id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--group-assignments-group-assignment--group-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idgroup-assignmentsgroup-assignmentgroup-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-id       | Group id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns images

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimages
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns images

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/images <#/definitions/images>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns image

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-name     | Image name     | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| application    | The            | query          | string         |                |
|                | application    |                |                |                |
|                | that the image |                |                |                |
|                | instantiates.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The vendor of  | query          | string         |                |
| ndor           | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The version of | query          | string         |                |
| rsion          | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/image <#/definitions/image>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing image

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

image object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/image <#/definitions/image>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing image

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadata

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idmetadata
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadata

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-name     | Image name     | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| application    | The            | query          | string         |                |
|                | application    |                |                |                |
|                | that the image |                |                |                |
|                | instantiates.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The vendor of  | query          | string         |                |
| ndor           | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The version of | query          | string         |                |
| rsion          | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadata <#/definitions/metadata>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadatum

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idmetadatametadatummetaname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-name     | Image name     | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| application    | The            | query          | string         |                |
|                | application    |                |                |                |
|                | that the image |                |                |                |
|                | instantiates.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The vendor of  | query          | string         |                |
| ndor           | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The version of | query          | string         |                |
| rsion          | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadatum <#/definitions/metadatum>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing metadatum

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idmetadatametadatummetaname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

metadatum object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/metadatum <#/definitions/metadatum>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--metadata-metadatum--metaname--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing metadatum

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idmetadatametadatummetaname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--images-image--image-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idimagesimageimage-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| image-id       | Image id,      | path           | string         |                |
|                | expected to be |                |                |                |
|                | unique across  |                |                |                |
|                | cloud region   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns oam-networks

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networks
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns oam-networks

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/oam-networks <#/definitions/oam-networks>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns oam-network

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networksoam-networknetwork-uuid
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns oam-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-uuid   | UUID of the    | path           | string         |                |
|                | network.       |                |                |                |
|                | Unique across  |                |                |                |
|                | a cloud-region |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | cvlan-id       | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/oam-network <#/definitions/oam-network>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing oam-network

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networksoam-networknetwork-uuid
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing oam-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

oam-network object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/oam-network <#/definitions/oam-network>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-uuid   | UUID of the    | path           | string         |                |
|                | network.       |                |                |                |
|                | Unique across  |                |                |                |
|                | a cloud-region |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing oam-network

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networksoam-networknetwork-uuid
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing oam-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-uuid   | UUID of the    | path           | string         |                |
|                | network.       |                |                |                |
|                | Unique across  |                |                |                |
|                | a cloud-region |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networksoam-networknetwork-uuidrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-uuid   | UUID of the    | path           | string         |                |
|                | network.       |                |                |                |
|                | Unique across  |                |                |                |
|                | a cloud-region |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--oam-networks-oam-network--network-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idoam-networksoam-networknetwork-uuidrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-uuid   | UUID of the    | path           | string         |                |
|                | network.       |                |                |                |
|                | Unique across  |                |                |                |
|                | a cloud-region |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns snapshots

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshots
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns snapshots

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/snapshots <#/definitions/snapshots>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns snapshot

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshotssnapshotsnapshot-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns snapshot

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-id    | Snapshot id,   | path           | string         |                |
|                | this is the    |                |                |                |
|                | key UUID assoc |                |                |                |
|                | associated in  |                |                |                |
|                | glance with    |                |                |                |
|                | the snapshots. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-name  | Snapshot name  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| application    | The            | query          | string         |                |
|                | application    |                |                |                |
|                | that the image |                |                |                |
|                | instantiates.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The vendor of  | query          | string         |                |
| ndor           | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The version of | query          | string         |                |
| rsion          | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prev-snapshot- | This field     | query          | string         |                |
| id             | contains the   |                |                |                |
|                | UUID of the    |                |                |                |
|                | previous       |                |                |                |
|                | snapshot (if   |                |                |                |
|                | any).          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/snapshot <#/definitions/snapshot>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing snapshot

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshotssnapshotsnapshot-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing snapshot

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

snapshot object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/snapshot <#/definitions/snapshot>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-id    | Snapshot id,   | path           | string         |                |
|                | this is the    |                |                |                |
|                | key UUID assoc |                |                |                |
|                | associated in  |                |                |                |
|                | glance with    |                |                |                |
|                | the snapshots. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing snapshot

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshotssnapshotsnapshot-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing snapshot

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-id    | Snapshot id,   | path           | string         |                |
|                | this is the    |                |                |                |
|                | key UUID assoc |                |                |                |
|                | associated in  |                |                |                |
|                | glance with    |                |                |                |
|                | the snapshots. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshotssnapshotsnapshot-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-id    | Snapshot id,   | path           | string         |                |
|                | this is the    |                |                |                |
|                | key UUID assoc |                |                |                |
|                | associated in  |                |                |                |
|                | glance with    |                |                |                |
|                | the snapshots. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--snapshots-snapshot--snapshot-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idsnapshotssnapshotsnapshot-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| snapshot-id    | Snapshot id,   | path           | string         |                |
|                | this is the    |                |                |                |
|                | key UUID assoc |                |                |                |
|                | associated in  |                |                |                |
|                | glance with    |                |                |                |
|                | the snapshots. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns tenants

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenants
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns tenants

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/tenants <#/definitions/tenants>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns tenant

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns tenant

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/tenant <#/definitions/tenant>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing tenant

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing tenant

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

tenant object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/tenant <#/definitions/tenant>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing tenant

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing tenant

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vservers

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvservers
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vservers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vservers <#/definitions/vservers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vserver

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vserver <#/definitions/vserver>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vserver

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vserver object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vserver <#/definitions/vserver>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vserver

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfaces
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns volumes

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumes
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns volumes

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/volumes <#/definitions/volumes>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns volume

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumesvolumevolume-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns volume

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-id      | Unique ID of   | path           | string         |                |
|                | block storage  |                |                |                |
|                | volume         |                |                |                |
|                | relative to    |                |                |                |
|                | the vserver.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-name    | Readable name  | query          | string         |                |
|                | of tenant      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-context | This field     | query          | string         |                |
|                | will store the |                |                |                |
|                | tenant         |                |                |                |
|                | context.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name   | Name of        | query          | string         |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-name2  | Alternative    | query          | string         |                |
|                | name of        |                |                |                |
|                | vserver        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/volume <#/definitions/volume>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing volume

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumesvolumevolume-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing volume

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

volume object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/volume <#/definitions/volume>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-id      | Unique ID of   | path           | string         |                |
|                | block storage  |                |                |                |
|                | volume         |                |                |                |
|                | relative to    |                |                |                |
|                | the vserver.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--tenants-tenant--tenant-id--vservers-vserver--vserver-id--volumes-volume--volume-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing volume

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumesvolumevolume-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing volume

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-id      | Unique ID of   | path           | string         |                |
|                | block storage  |                |                |                |
|                | volume         |                |                |                |
|                | relative to    |                |                |                |
|                | the vserver.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumesvolumevolume-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-id      | Unique ID of   | path           | string         |                |
|                | block storage  |                |                |                |
|                | volume         |                |                |                |
|                | relative to    |                |                |                |
|                | the vserver.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idtenantstenanttenant-idvserversvservervserver-idvolumesvolumevolume-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| tenant-id      | Unique id      | path           | string         |                |
|                | relative to    |                |                |                |
|                | the            |                |                |                |
|                | cloud-region.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vserver-id     | Unique         | path           | string         |                |
|                | identifier for |                |                |                |
|                | this vserver   |                |                |                |
|                | relative to    |                |                |                |
|                | its tenant     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-id      | Unique ID of   | path           | string         |                |
|                | block storage  |                |                |                |
|                | volume         |                |                |                |
|                | relative to    |                |                |                |
|                | the vserver.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vip-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv4-address-listvip-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vip-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv4-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vip-ipv4-address-list <#/definitions/vip-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vip-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv4-address-listvip-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vip-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vip-ipv4-address-list object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vip-ipv4-address-list <#/definitions/vip-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv4-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vip-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv4-address-listvip-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vip-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv4-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv4-address-listvip-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv4-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv4-address-list--vip-ipv4-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv4-address-listvip-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv4-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vip-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv6-address-listvip-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vip-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv6-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vip-ipv6-address-list <#/definitions/vip-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vip-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv6-address-listvip-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vip-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vip-ipv6-address-list object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vip-ipv6-address-list <#/definitions/vip-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv6-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vip-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv6-address-listvip-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vip-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv6-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv6-address-listvip-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv6-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--vip-ipv6-address-list--vip-ipv6-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvip-ipv6-address-listvip-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vip-ipv6-addre | IP address     | path           | string         |                |
| ss             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns volume-groups

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groups
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns volume-groups

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/volume-groups <#/definitions/volume-groups>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns volume-group

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}**
   :name: get-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groupsvolume-groupvolume-group-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns volume-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-i | Unique ID of   | path           | string         |                |
| d              | volume-group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-type     | Type of the    | query          | string         |                |
|                | cloud (e.g.,   |                |                |                |
|                | openstack)     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| owner-defined- | Cloud-owner    | query          | string         |                |
| type           | defined type   |                |                |                |
|                | indicator      |                |                |                |
|                | (e.g., dcp,    |                |                |                |
|                | lcp)           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-n | Name of the    | query          | string         |                |
| ame            | volume group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | volume-group   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/volume-group <#/definitions/volume-group>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing volume-group

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groupsvolume-groupvolume-group-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing volume-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

volume-group object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/volume-group <#/definitions/volume-group>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-i | Unique ID of   | path           | string         |                |
| d              | volume-group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing volume-group

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groupsvolume-groupvolume-group-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing volume-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-i | Unique ID of   | path           | string         |                |
| d              | volume-group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groupsvolume-groupvolume-group-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-i | Unique ID of   | path           | string         |                |
| d              | volume-group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-cloud-regions-cloud-region--cloud-owner---cloud-region-id--volume-groups-volume-group--volume-group-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecloud-regionscloud-regioncloud-ownercloud-region-idvolume-groupsvolume-groupvolume-group-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| cloud-owner    | Identifies the | path           | string         |                |
|                | vendor and     |                |                |                |
|                | cloud name.    |                |                |                |
|                | First part of  |                |                |                |
|                | composite key  |                |                |                |
|                | should be      |                |                |                |
|                | formatted as   |                |                |                |
|                | vendor-cloudna |                |                |                |
|                | me             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cloud-region-i | Identifier     | path           | string         |                |
| d              | used by the    |                |                |                |
|                | vendor for the |                |                |                |
|                | region. Second |                |                |                |
|                | part of        |                |                |                |
|                | composite key  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| volume-group-i | Unique ID of   | path           | string         |                |
| d              | volume-group.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--cloud-infrastructure-complexes-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns complexes

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/complexes**
   :name: get-cloud-infrastructurecomplexes
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns complexes

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/complexes <#/definitions/complexes>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns complex

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/complexes/complex/{physical-location-id}**
   :name: get-cloud-infrastructurecomplexescomplexphysical-location-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns complex

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| data-center-co | Data center    | query          | string         |                |
| de             | code which can |                |                |                |
|                | be an          |                |                |                |
|                | alternate way  |                |                |                |
|                | to identify a  |                |                |                |
|                | complex        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| complex-name   | Gamma complex  | query          | string         |                |
|                | name for LCP   |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| identity-url   | URL of the     | query          | string         |                |
|                | keystone       |                |                |                |
|                | identity       |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/complex <#/definitions/complex>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing complex

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/complexes/complex/{physical-location-id}**
   :name: put-cloud-infrastructurecomplexescomplexphysical-location-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing complex

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

complex object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/complex <#/definitions/complex>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing complex

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/complexes/complex/{physical-location-id}**
   :name: delete-cloud-infrastructurecomplexescomplexphysical-location-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing complex

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ctag-pools

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools**
   :name: get-cloud-infrastructurecomplexescomplexphysical-location-idctag-pools
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ctag-pools

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| data-center-co | Data center    | query          | string         |                |
| de             | code which can |                |                |                |
|                | be an          |                |                |                |
|                | alternate way  |                |                |                |
|                | to identify a  |                |                |                |
|                | complex        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| complex-name   | Gamma complex  | query          | string         |                |
|                | name for LCP   |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| identity-url   | URL of the     | query          | string         |                |
|                | keystone       |                |                |                |
|                | identity       |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ctag-pools <#/definitions/ctag-pools>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ctag-pool

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}**
   :name: get-cloud-infrastructurecomplexescomplexphysical-location-idctag-poolsctag-pooltarget-peavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ctag-pool

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| target-pe      | The Target     | path           | string         |                |
|                | provider edge  |                |                |                |
|                | router         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| data-center-co | Data center    | query          | string         |                |
| de             | code which can |                |                |                |
|                | be an          |                |                |                |
|                | alternate way  |                |                |                |
|                | to identify a  |                |                |                |
|                | complex        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| complex-name   | Gamma complex  | query          | string         |                |
|                | name for LCP   |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| identity-url   | URL of the     | query          | string         |                |
|                | keystone       |                |                |                |
|                | identity       |                |                |                |
|                | service        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ctag-pool <#/definitions/ctag-pool>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing ctag-pool

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}**
   :name: put-cloud-infrastructurecomplexescomplexphysical-location-idctag-poolsctag-pooltarget-peavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing ctag-pool

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

ctag-pool object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/ctag-pool <#/definitions/ctag-pool>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| target-pe      | The Target     | path           | string         |                |
|                | provider edge  |                |                |                |
|                | router         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing ctag-pool

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}**
   :name: delete-cloud-infrastructurecomplexescomplexphysical-location-idctag-poolsctag-pooltarget-peavailability-zone-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing ctag-pool

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| target-pe      | The Target     | path           | string         |                |
|                | provider edge  |                |                |                |
|                | router         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurecomplexescomplexphysical-location-idctag-poolsctag-pooltarget-peavailability-zone-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| target-pe      | The Target     | path           | string         |                |
|                | provider edge  |                |                |                |
|                | router         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--ctag-pools-ctag-pool--target-pe---availability-zone-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecomplexescomplexphysical-location-idctag-poolsctag-pooltarget-peavailability-zone-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| target-pe      | The Target     | path           | string         |                |
|                | provider edge  |                |                |                |
|                | router         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| availability-z | Name of the    | path           | string         |                |
| one-name       | availability   |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurecomplexescomplexphysical-location-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-complexes-complex--physical-location-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/complexes/complex/{physical-location-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurecomplexescomplexphysical-location-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| physical-locat | Unique         | path           | string         |                |
| ion-id         | identifier for |                |                |                |
|                | physical       |                |                |                |
|                | location,      |                |                |                |
|                | e.g., CLLI     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--cloud-infrastructure-network-profiles-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns network-profiles

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/network-profiles**
   :name: get-cloud-infrastructurenetwork-profiles
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns network-profiles

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/network-profiles <#/definitions/network-profiles>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns network-profile

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}**
   :name: get-cloud-infrastructurenetwork-profilesnetwork-profilenm-profile-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns network-profile

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| nm-profile-nam | Unique name of | path           | string         |                |
| e              | network        |                |                |                |
|                | profile.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/network-profile <#/definitions/network-profile>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing network-profile

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}**
   :name: put-cloud-infrastructurenetwork-profilesnetwork-profilenm-profile-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing network-profile

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

network-profile object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/network-profile <#/definitions/network-profile>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| nm-profile-nam | Unique name of | path           | string         |                |
| e              | network        |                |                |                |
|                | profile.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing network-profile

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}**
   :name: delete-cloud-infrastructurenetwork-profilesnetwork-profilenm-profile-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing network-profile

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| nm-profile-nam | Unique name of | path           | string         |                |
| e              | network        |                |                |                |
|                | profile.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurenetwork-profilesnetwork-profilenm-profile-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| nm-profile-nam | Unique name of | path           | string         |                |
| e              | network        |                |                |                |
|                | profile.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-network-profiles-network-profile--nm-profile-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurenetwork-profilesnetwork-profilenm-profile-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| nm-profile-nam | Unique name of | path           | string         |                |
| e              | network        |                |                |                |
|                | profile.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--cloud-infrastructure-pservers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns pservers

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/pservers**
   :name: get-cloud-infrastructurepservers
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns pservers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/pservers <#/definitions/pservers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns pserver

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/pservers/pserver/{hostname}**
   :name: get-cloud-infrastructurepserverspserverhostname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns pserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/pserver <#/definitions/pserver>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing pserver

.. raw:: html

   </div>

.. rubric:: PUT **/cloud-infrastructure/pservers/pserver/{hostname}**
   :name: put-cloud-infrastructurepserverspserverhostname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing pserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

pserver object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/pserver <#/definitions/pserver>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing pserver

.. raw:: html

   </div>

.. rubric:: DELETE **/cloud-infrastructure/pservers/pserver/{hostname}**
   :name: delete-cloud-infrastructurepserverspserverhostname
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing pserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaces
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interfaces <#/definitions/lag-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing lag-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

lag-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/lag-interface <#/definitions/lag-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing lag-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfaces
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interfaces <#/definitions/p-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interface <#/definitions/p-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing p-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

p-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/p-interface <#/definitions/p-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing p-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pfs

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfs
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pfs <#/definitions/sriov-pfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pf

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: get-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-id     | ID of Pserver  | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| pserver-name2  | alternative    | query          | string         |                |
|                | pserver name   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pf <#/definitions/sriov-pf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-pf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-pf <#/definitions/sriov-pf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship**
   :name: put-cloud-infrastructurepserverspserverhostnamerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-pservers-pserver--hostname--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/pservers/pserver/{hostname}/relationship-list/relationship**
   :name: delete-cloud-infrastructurepserverspserverhostnamerelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| hostname       | Value from     | path           | string         |                |
|                | executing      |                |                |                |
|                | hostname on    |                |                |                |
|                | the compute    |                |                |                |
|                | node.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--cloud-infrastructure-virtual-data-centers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns virtual-data-centers

.. raw:: html

   </div>

.. rubric:: GET **/cloud-infrastructure/virtual-data-centers**
   :name: get-cloud-infrastructurevirtual-data-centers
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns virtual-data-centers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/virtual-data-centers <#/definitions/virtual-data-centers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns virtual-data-center

.. raw:: html

   </div>

.. rubric:: GET
   **/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}**
   :name: get-cloud-infrastructurevirtual-data-centersvirtual-data-centervdc-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns virtual-data-center

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vdc-id         | Unique ID of   | path           | string         |                |
|                | the vdc        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vdc-name       | Name of the    | query          | string         |                |
|                | virtual data   |                |                |                |
|                | center         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/virtual-data-center <#/definitions/virtual-data-center>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing virtual-data-center

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}**
   :name: put-cloud-infrastructurevirtual-data-centersvirtual-data-centervdc-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing virtual-data-center

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

virtual-data-center object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/virtual-data-center <#/definitions/virtual-data-center>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vdc-id         | Unique ID of   | path           | string         |                |
|                | the vdc        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing virtual-data-center

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}**
   :name: delete-cloud-infrastructurevirtual-data-centersvirtual-data-centervdc-id
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing virtual-data-center

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vdc-id         | Unique ID of   | path           | string         |                |
|                | the vdc        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship**
   :name: put-cloud-infrastructurevirtual-data-centersvirtual-data-centervdc-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vdc-id         | Unique ID of   | path           | string         |                |
|                | the vdc        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--cloud-infrastructure-virtual-data-centers-virtual-data-center--vdc-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}/relationship-list/relationship**
   :name: delete-cloud-infrastructurevirtual-data-centersvirtual-data-centervdc-idrelationship-listrelationship
   :class: panel-title

Tags: `CloudInfrastructure <#tag-CloudInfrastructure>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vdc-id         | Unique ID of   | path           | string         |                |
|                | the vdc        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--external-system-esr-ems-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-ems-list

.. raw:: html

   </div>

.. rubric:: GET **/external-system/esr-ems-list**
   :name: get-external-systemesr-ems-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-ems-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-ems-list <#/definitions/esr-ems-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-ems

.. raw:: html

   </div>

.. rubric:: GET **/external-system/esr-ems-list/esr-ems/{ems-id}**
   :name: get-external-systemesr-ems-listesr-emsems-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-ems

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-ems <#/definitions/esr-ems>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-ems

.. raw:: html

   </div>

.. rubric:: PUT **/external-system/esr-ems-list/esr-ems/{ems-id}**
   :name: put-external-systemesr-ems-listesr-emsems-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-ems

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-ems object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-ems <#/definitions/esr-ems>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-ems

.. raw:: html

   </div>

.. rubric:: DELETE **/external-system/esr-ems-list/esr-ems/{ems-id}**
   :name: delete-external-systemesr-ems-listesr-emsems-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-ems

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info-list

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list**
   :name: get-external-systemesr-ems-listesr-emsems-idesr-system-info-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info-list <#/definitions/esr-system-info-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-esr-system-info--esr-system-info-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: get-external-systemesr-ems-listesr-emsems-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-name    | name of        | query          | string         |                |
|                | external       |                |                |                |
|                | system.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-type    | it could be    | query          | string         |                |
|                | vim/vnfm/third |                |                |                |
|                | party-sdnc/ems |                |                |                |
|                | -resource/ems- |                |                |                |
|                | performance/em |                |                |                |
|                | s-alarm.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-esr-system-info--esr-system-info-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: put-external-systemesr-ems-listesr-emsems-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-system-info object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-system-info <#/definitions/esr-system-info>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: delete-external-systemesr-ems-listesr-emsems-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: put-external-systemesr-ems-listesr-emsems-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: delete-external-systemesr-ems-listesr-emsems-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship**
   :name: put-external-systemesr-ems-listesr-emsems-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-ems-list-esr-ems--ems-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship**
   :name: delete-external-systemesr-ems-listesr-emsems-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ems-id         | Unique ID of   | path           | string         |                |
|                | EMS.           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--external-system-esr-thirdparty-sdnc-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-thirdparty-sdnc-list

.. raw:: html

   </div>

.. rubric:: GET **/external-system/esr-thirdparty-sdnc-list**
   :name: get-external-systemesr-thirdparty-sdnc-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-thirdparty-sdnc-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-thirdparty-sdnc-list <#/definitions/esr-thirdparty-sdnc-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-thirdparty-sdnc

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}**
   :name: get-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-thirdparty-sdnc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-thirdparty-sdnc <#/definitions/esr-thirdparty-sdnc>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-thirdparty-sdnc

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}**
   :name: put-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-thirdparty-sdnc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-thirdparty-sdnc object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-thirdparty-sdnc <#/definitions/esr-thirdparty-sdnc>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-thirdparty-sdnc

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}**
   :name: delete-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-thirdparty-sdnc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info-list

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list**
   :name: get-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info-list <#/definitions/esr-system-info-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-esr-system-info--esr-system-info-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: get-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-name    | name of        | query          | string         |                |
|                | external       |                |                |                |
|                | system.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-type    | it could be    | query          | string         |                |
|                | vim/vnfm/third |                |                |                |
|                | party-sdnc/ems |                |                |                |
|                | -resource/ems- |                |                |                |
|                | performance/em |                |                |                |
|                | s-alarm.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-esr-system-info--esr-system-info-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: put-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-system-info object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-system-info <#/definitions/esr-system-info>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: delete-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: put-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: delete-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship**
   :name: put-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-thirdparty-sdnc-list-esr-thirdparty-sdnc--thirdparty-sdnc-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship**
   :name: delete-external-systemesr-thirdparty-sdnc-listesr-thirdparty-sdncthirdparty-sdnc-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| thirdparty-sdn | Unique ID of   | path           | string         |                |
| c-id           | SDNC.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--external-system-esr-vnfm-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-vnfm-list

.. raw:: html

   </div>

.. rubric:: GET **/external-system/esr-vnfm-list**
   :name: get-external-systemesr-vnfm-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-vnfm-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-vnfm-list <#/definitions/esr-vnfm-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-vnfm

.. raw:: html

   </div>

.. rubric:: GET **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}**
   :name: get-external-systemesr-vnfm-listesr-vnfmvnfm-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-vnfm

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-vnfm <#/definitions/esr-vnfm>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-vnfm

.. raw:: html

   </div>

.. rubric:: PUT **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}**
   :name: put-external-systemesr-vnfm-listesr-vnfmvnfm-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-vnfm

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-vnfm object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-vnfm <#/definitions/esr-vnfm>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-vnfm

.. raw:: html

   </div>

.. rubric:: DELETE **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}**
   :name: delete-external-systemesr-vnfm-listesr-vnfmvnfm-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-vnfm

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info-list

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list**
   :name: get-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-list
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info-list <#/definitions/esr-system-info-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-esr-system-info--esr-system-info-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns esr-system-info

.. raw:: html

   </div>

.. rubric:: GET
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: get-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-name    | name of        | query          | string         |                |
|                | external       |                |                |                |
|                | system.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| system-type    | it could be    | query          | string         |                |
|                | vim/vnfm/third |                |                |                |
|                | party-sdnc/ems |                |                |                |
|                | -resource/ems- |                |                |                |
|                | performance/em |                |                |                |
|                | s-alarm.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-esr-system-info--esr-system-info-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: put-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

esr-system-info object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/esr-system-info <#/definitions/esr-system-info>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-esr-system-info--esr-system-info-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing esr-system-info

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}**
   :name: delete-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-listesr-system-infoesr-system-info-id
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing esr-system-info

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: put-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--esr-system-info-list-esr-system-info--esr-system-info-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship**
   :name: delete-external-systemesr-vnfm-listesr-vnfmvnfm-idesr-system-info-listesr-system-infoesr-system-info-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| esr-system-inf | Unique ID of   | path           | string         |                |
| o-id           | esr system     |                |                |                |
|                | info.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship**
   :name: put-external-systemesr-vnfm-listesr-vnfmvnfm-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--external-system-esr-vnfm-list-esr-vnfm--vnfm-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship**
   :name: delete-external-systemesr-vnfm-listesr-vnfmvnfm-idrelationship-listrelationship
   :class: panel-title

Tags: `ExternalSystem <#tag-ExternalSystem>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfm-id        | Unique ID of   | path           | string         |                |
|                | VNFM.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-generic-vnfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns generic-vnfs

.. raw:: html

   </div>

.. rubric:: GET **/network/generic-vnfs**
   :name: get-networkgeneric-vnfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns generic-vnfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/generic-vnfs <#/definitions/generic-vnfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns generic-vnf

.. raw:: html

   </div>

.. rubric:: GET **/network/generic-vnfs/generic-vnf/{vnf-id}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/generic-vnf <#/definitions/generic-vnf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing generic-vnf

.. raw:: html

   </div>

.. rubric:: PUT **/network/generic-vnfs/generic-vnf/{vnf-id}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

generic-vnf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/generic-vnf <#/definitions/generic-vnf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-generic-vnfs-generic-vnf--vnf-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing generic-vnf

.. raw:: html

   </div>

.. rubric:: DELETE **/network/generic-vnfs/generic-vnf/{vnf-id}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns entitlements

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-identitlements
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns entitlements

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/entitlements <#/definitions/entitlements>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns entitlement

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/entitlement <#/definitions/entitlement>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing entitlement

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

entitlement object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/entitlement <#/definitions/entitlement>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing entitlement

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-identitlementsentitlementgroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-identitlementsentitlementgroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idl-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interfaces <#/definitions/lag-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing lag-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

lag-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/lag-interface <#/definitions/lag-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing lag-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns licenses

.. raw:: html

   </div>

.. rubric:: GET **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlicenses
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns licenses

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/licenses <#/definitions/licenses>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns license

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/license <#/definitions/license>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing license

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

license object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/license <#/definitions/license>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing license

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idlicenseslicensegroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idlicenseslicensegroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vf-modules

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idvf-modules
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vf-modules

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vf-modules <#/definitions/vf-modules>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vf-module

.. raw:: html

   </div>

.. rubric:: GET
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}**
   :name: get-networkgeneric-vnfsgeneric-vnfvnf-idvf-modulesvf-modulevf-module-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vf-module

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-id   | Unique ID of   | path           | string         |                |
|                | vf-module.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not            |                |                |                |
|                | necessarily    |                |                |                |
|                | map to ASDC    |                |                |                |
|                | service        |                |                |                |
|                | models. SOON   |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-type        | Generic        | query          | string         |                |
|                | description of |                |                |                |
|                | the type of NF |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-function    | English        | query          | string         |                |
|                | description of |                |                |                |
|                | Network        |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | VNF deployment |                |                |                |
|                | is providing   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-role        | role in the    | query          | string         |                |
|                | network that   |                |                |                |
|                | this model     |                |                |                |
|                | will be        |                |                |                |
|                | providing      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nf-naming-code | string         | query          | string         |                |
|                | assigned to    |                |                |                |
|                | this model     |                |                |                |
|                | used for       |                |                |                |
|                | naming         |                |                |                |
|                | purposes       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-name | Name of        | query          | string         |                |
|                | vf-module      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-servi | the Contrail   | query          | string         |                |
| ce-instance-fq | unique ID for  |                |                |                |
| dn             | a              |                |                |                |
|                | service-instan |                |                |                |
|                | ce             |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vf-module <#/definitions/vf-module>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vf-module

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idvf-modulesvf-modulevf-module-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vf-module

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vf-module object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vf-module <#/definitions/vf-module>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-id   | Unique ID of   | path           | string         |                |
|                | vf-module.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vf-module

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idvf-modulesvf-modulevf-module-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vf-module

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-id   | Unique ID of   | path           | string         |                |
|                | vf-module.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship**
   :name: put-networkgeneric-vnfsgeneric-vnfvnf-idvf-modulesvf-modulevf-module-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-id   | Unique ID of   | path           | string         |                |
|                | vf-module.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-generic-vnfs-generic-vnf--vnf-id--vf-modules-vf-module--vf-module-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship**
   :name: delete-networkgeneric-vnfsgeneric-vnfvnf-idvf-modulesvf-modulevf-module-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-module-id   | Unique ID of   | path           | string         |                |
|                | vf-module.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-instance-groups-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns instance-groups

.. raw:: html

   </div>

.. rubric:: GET **/network/instance-groups**
   :name: get-networkinstance-groups
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns instance-groups

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/instance-groups <#/definitions/instance-groups>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-instance-groups-instance-group--id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns instance-group

.. raw:: html

   </div>

.. rubric:: GET **/network/instance-groups/instance-group/{id}**
   :name: get-networkinstance-groupsinstance-groupid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns instance-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| id             | Instance Group | path           | string         |                |
|                | ID, UUID       |                |                |                |
|                | assigned to    |                |                |                |
|                | this instance. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| description    | Descriptive    | query          | string         |                |
|                | text to help   |                |                |                |
|                | identify the   |                |                |                |
|                | usage of this  |                |                |                |
|                | instance-group |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| type           | Only valid     | query          | string         |                |
|                | value today is |                |                |                |
|                | lower case ha  |                |                |                |
|                | for high       |                |                |                |
|                | availability   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| sub-type       | Valid values   | query          | string         |                |
|                | for ha type    |                |                |                |
|                | are            |                |                |                |
|                | [geo-activeact |                |                |                |
|                | ive,           |                |                |                |
|                | geo-activestan |                |                |                |
|                | dby,           |                |                |                |
|                | local-activeac |                |                |                |
|                | tive,          |                |                |                |
|                | local-activest |                |                |                |
|                | andby]         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/instance-group <#/definitions/instance-group>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-instance-groups-instance-group--id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing instance-group

.. raw:: html

   </div>

.. rubric:: PUT **/network/instance-groups/instance-group/{id}**
   :name: put-networkinstance-groupsinstance-groupid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing instance-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

instance-group object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/instance-group <#/definitions/instance-group>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| id             | Instance Group | path           | string         |                |
|                | ID, UUID       |                |                |                |
|                | assigned to    |                |                |                |
|                | this instance. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-instance-groups-instance-group--id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing instance-group

.. raw:: html

   </div>

.. rubric:: DELETE **/network/instance-groups/instance-group/{id}**
   :name: delete-networkinstance-groupsinstance-groupid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing instance-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| id             | Instance Group | path           | string         |                |
|                | ID, UUID       |                |                |                |
|                | assigned to    |                |                |                |
|                | this instance. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-instance-groups-instance-group--id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/instance-groups/instance-group/{id}/relationship-list/relationship**
   :name: put-networkinstance-groupsinstance-groupidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| id             | Instance Group | path           | string         |                |
|                | ID, UUID       |                |                |                |
|                | assigned to    |                |                |                |
|                | this instance. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-instance-groups-instance-group--id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/instance-groups/instance-group/{id}/relationship-list/relationship**
   :name: delete-networkinstance-groupsinstance-groupidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| id             | Instance Group | path           | string         |                |
|                | ID, UUID       |                |                |                |
|                | assigned to    |                |                |                |
|                | this instance. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-ipsec-configurations-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ipsec-configurations

.. raw:: html

   </div>

.. rubric:: GET **/network/ipsec-configurations**
   :name: get-networkipsec-configurations
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ipsec-configurations

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ipsec-configurations <#/definitions/ipsec-configurations>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ipsec-configuration

.. raw:: html

   </div>

.. rubric:: GET
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}**
   :name: get-networkipsec-configurationsipsec-configurationipsec-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ipsec-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ipsec-configuration <#/definitions/ipsec-configuration>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing ipsec-configuration

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}**
   :name: put-networkipsec-configurationsipsec-configurationipsec-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing ipsec-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

ipsec-configuration object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/ipsec-configuration <#/definitions/ipsec-configuration>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing ipsec-configuration

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}**
   :name: delete-networkipsec-configurationsipsec-configurationipsec-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing ipsec-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship**
   :name: put-networkipsec-configurationsipsec-configurationipsec-configuration-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship**
   :name: delete-networkipsec-configurationsipsec-configurationipsec-configuration-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vig-servers

.. raw:: html

   </div>

.. rubric:: GET
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers**
   :name: get-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-servers
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vig-servers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vig-servers <#/definitions/vig-servers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vig-server

.. raw:: html

   </div>

.. rubric:: GET
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}**
   :name: get-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-serversvig-servervig-address-type
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vig-server

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vig-address-ty | indicates      | path           | string         |                |
| pe             | whether the    |                |                |                |
|                | VIG is for     |                |                |                |
|                | AVPN or        |                |                |                |
|                | INTERNET       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vig-server <#/definitions/vig-server>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vig-server

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}**
   :name: put-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-serversvig-servervig-address-type
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vig-server

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vig-server object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vig-server <#/definitions/vig-server>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vig-address-ty | indicates      | path           | string         |                |
| pe             | whether the    |                |                |                |
|                | VIG is for     |                |                |                |
|                | AVPN or        |                |                |                |
|                | INTERNET       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vig-server

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}**
   :name: delete-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-serversvig-servervig-address-type
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vig-server

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vig-address-ty | indicates      | path           | string         |                |
| pe             | whether the    |                |                |                |
|                | VIG is for     |                |                |                |
|                | AVPN or        |                |                |                |
|                | INTERNET       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship**
   :name: put-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-serversvig-servervig-address-typerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vig-address-ty | indicates      | path           | string         |                |
| pe             | whether the    |                |                |                |
|                | VIG is for     |                |                |                |
|                | AVPN or        |                |                |                |
|                | INTERNET       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-ipsec-configurations-ipsec-configuration--ipsec-configuration-id--vig-servers-vig-server--vig-address-type--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship**
   :name: delete-networkipsec-configurationsipsec-configurationipsec-configuration-idvig-serversvig-servervig-address-typerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| ipsec-configur | UUID of this   | path           | string         |                |
| ation-id       | configuration  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vig-address-ty | indicates      | path           | string         |                |
| pe             | whether the    |                |                |                |
|                | VIG is for     |                |                |                |
|                | AVPN or        |                |                |                |
|                | INTERNET       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-l3-networks-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-networks

.. raw:: html

   </div>

.. rubric:: GET **/network/l3-networks**
   :name: get-networkl3-networks
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-networks

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-networks <#/definitions/l3-networks>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-l3-networks-l3-network--network-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-network

.. raw:: html

   </div>

.. rubric:: GET **/network/l3-networks/l3-network/{network-id}**
   :name: get-networkl3-networksl3-networknetwork-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-network <#/definitions/l3-network>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-l3-networks-l3-network--network-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-network

.. raw:: html

   </div>

.. rubric:: PUT **/network/l3-networks/l3-network/{network-id}**
   :name: put-networkl3-networksl3-networknetwork-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-network object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-network <#/definitions/l3-network>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-network

.. raw:: html

   </div>

.. rubric:: DELETE **/network/l3-networks/l3-network/{network-id}**
   :name: delete-networkl3-networksl3-networknetwork-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ctag-assignments

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments**
   :name: get-networkl3-networksl3-networknetwork-idctag-assignments
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ctag-assignments

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ctag-assignments <#/definitions/ctag-assignments>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns ctag-assignment

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}**
   :name: get-networkl3-networksl3-networknetwork-idctag-assignmentsctag-assignmentvlan-id-inner
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns ctag-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | id.            | path           | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/ctag-assignment <#/definitions/ctag-assignment>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing ctag-assignment

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}**
   :name: put-networkl3-networksl3-networknetwork-idctag-assignmentsctag-assignmentvlan-id-inner
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing ctag-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

ctag-assignment object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/ctag-assignment <#/definitions/ctag-assignment>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | id.            | path           | integer        |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing ctag-assignment

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}**
   :name: delete-networkl3-networksl3-networknetwork-idctag-assignmentsctag-assignmentvlan-id-inner
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing ctag-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | id.            | path           | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship**
   :name: put-networkl3-networksl3-networknetwork-idctag-assignmentsctag-assignmentvlan-id-innerrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | id.            | path           | integer        |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--ctag-assignments-ctag-assignment--vlan-id-inner--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship**
   :name: delete-networkl3-networksl3-networknetwork-idctag-assignmentsctag-assignmentvlan-id-innerrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | id.            | path           | integer        |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/relationship-list/relationship**
   :name: put-networkl3-networksl3-networknetwork-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/relationship-list/relationship**
   :name: delete-networkl3-networksl3-networknetwork-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns segmentation-assignments

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments**
   :name: get-networkl3-networksl3-networknetwork-idsegmentation-assignments
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns segmentation-assignments

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/segmentation-assignments <#/definitions/segmentation-assignments>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns segmentation-assignment

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}**
   :name: get-networkl3-networksl3-networknetwork-idsegmentation-assignmentssegmentation-assignmentsegmentation-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns segmentation-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| segmentation-i | Route Table    | path           | string         |                |
| d              | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/segmentation-assignment <#/definitions/segmentation-assignment>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing segmentation-assignment

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}**
   :name: put-networkl3-networksl3-networknetwork-idsegmentation-assignmentssegmentation-assignmentsegmentation-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing segmentation-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

segmentation-assignment object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/segmentation-assignment <#/definitions/segmentation-assignment>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| segmentation-i | Route Table    | path           | string         |                |
| d              | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing segmentation-assignment

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}**
   :name: delete-networkl3-networksl3-networknetwork-idsegmentation-assignmentssegmentation-assignmentsegmentation-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing segmentation-assignment

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| segmentation-i | Route Table    | path           | string         |                |
| d              | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship**
   :name: put-networkl3-networksl3-networknetwork-idsegmentation-assignmentssegmentation-assignmentsegmentation-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| segmentation-i | Route Table    | path           | string         |                |
| d              | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--segmentation-assignments-segmentation-assignment--segmentation-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship**
   :name: delete-networkl3-networksl3-networknetwork-idsegmentation-assignmentssegmentation-assignmentsegmentation-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| segmentation-i | Route Table    | path           | string         |                |
| d              | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns subnets

.. raw:: html

   </div>

.. rubric:: GET **/network/l3-networks/l3-network/{network-id}/subnets**
   :name: get-networkl3-networksl3-networknetwork-idsubnets
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns subnets

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/subnets <#/definitions/subnets>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns subnet

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}**
   :name: get-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns subnet

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-name    | Name           | query          | string         |                |
|                | associated     |                |                |                |
|                | with the       |                |                |                |
|                | subnet.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/subnet <#/definitions/subnet>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing subnet

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}**
   :name: put-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing subnet

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

subnet object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/subnet <#/definitions/subnet>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing subnet

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}**
   :name: delete-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing subnet

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns host-routes

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes**
   :name: get-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routes
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns host-routes

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-name    | Name           | query          | string         |                |
|                | associated     |                |                |                |
|                | with the       |                |                |                |
|                | subnet.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/host-routes <#/definitions/host-routes>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns host-route

.. raw:: html

   </div>

.. rubric:: GET
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}**
   :name: get-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routeshost-routehost-route-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns host-route

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| host-route-id  | host-route id  | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network,       |                |                |                |
|                | governed by    |                |                |                |
|                | some naming    |                |                |                |
|                | convention..   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-role   | Role the       | query          | string         |                |
|                | network plans  |                |                |                |
|                | - who defines  |                |                |                |
|                | these values?  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service from   |                |                |                |
|                | ASDC. Does not |                |                |                |
|                | strictly map   |                |                |                |
|                | to ASDC        |                |                |                |
|                | services. SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| contrail-netwo | Contrail FQDN  | query          | string         |                |
| rk-fqdn        | for the        |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-name    | Name           | query          | string         |                |
|                | associated     |                |                |                |
|                | with the       |                |                |                |
|                | subnet.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/host-route <#/definitions/host-route>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing host-route

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}**
   :name: put-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routeshost-routehost-route-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing host-route

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

host-route object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/host-route <#/definitions/host-route>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| host-route-id  | host-route id  | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing host-route

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}**
   :name: delete-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routeshost-routehost-route-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing host-route

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| host-route-id  | host-route id  | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship**
   :name: put-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routeshost-routehost-route-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| host-route-id  | host-route id  | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--host-routes-host-route--host-route-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship**
   :name: delete-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idhost-routeshost-routehost-route-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| host-route-id  | host-route id  | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship**
   :name: put-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-l3-networks-l3-network--network-id--subnets-subnet--subnet-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship**
   :name: delete-networkl3-networksl3-networknetwork-idsubnetssubnetsubnet-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-id     | Network ID,    | path           | string         |                |
|                | should be      |                |                |                |
|                | uuid. Unique   |                |                |                |
|                | across A&AI.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| subnet-id      | Subnet ID,     | path           | string         |                |
|                | should be      |                |                |                |
|                | UUID.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-lag-links-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-links

.. raw:: html

   </div>

.. rubric:: GET **/network/lag-links**
   :name: get-networklag-links
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-links

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-links <#/definitions/lag-links>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-lag-links-lag-link--link-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-link

.. raw:: html

   </div>

.. rubric:: GET **/network/lag-links/lag-link/{link-name}**
   :name: get-networklag-linkslag-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | Alphabetical   | path           | string         |                |
|                | concatenation  |                |                |                |
|                | of             |                |                |                |
|                | lag-interface  |                |                |                |
|                | names          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-link <#/definitions/lag-link>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-lag-links-lag-link--link-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing lag-link

.. raw:: html

   </div>

.. rubric:: PUT **/network/lag-links/lag-link/{link-name}**
   :name: put-networklag-linkslag-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing lag-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

lag-link object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/lag-link <#/definitions/lag-link>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | Alphabetical   | path           | string         |                |
|                | concatenation  |                |                |                |
|                | of             |                |                |                |
|                | lag-interface  |                |                |                |
|                | names          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-lag-links-lag-link--link-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing lag-link

.. raw:: html

   </div>

.. rubric:: DELETE **/network/lag-links/lag-link/{link-name}**
   :name: delete-networklag-linkslag-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing lag-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | Alphabetical   | path           | string         |                |
|                | concatenation  |                |                |                |
|                | of             |                |                |                |
|                | lag-interface  |                |                |                |
|                | names          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-lag-links-lag-link--link-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/lag-links/lag-link/{link-name}/relationship-list/relationship**
   :name: put-networklag-linkslag-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | Alphabetical   | path           | string         |                |
|                | concatenation  |                |                |                |
|                | of             |                |                |                |
|                | lag-interface  |                |                |                |
|                | names          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-lag-links-lag-link--link-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/lag-links/lag-link/{link-name}/relationship-list/relationship**
   :name: delete-networklag-linkslag-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | Alphabetical   | path           | string         |                |
|                | concatenation  |                |                |                |
|                | of             |                |                |                |
|                | lag-interface  |                |                |                |
|                | names          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-logical-links-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns logical-links

.. raw:: html

   </div>

.. rubric:: GET **/network/logical-links**
   :name: get-networklogical-links
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns logical-links

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/logical-links <#/definitions/logical-links>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-logical-links-logical-link--link-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns logical-link

.. raw:: html

   </div>

.. rubric:: GET **/network/logical-links/logical-link/{link-name}**
   :name: get-networklogical-linkslogical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | evc-name, or   |                |                |                |
|                | vnf-nameA\_int |                |                |                |
|                | erface-nameA\_ |                |                |                |
|                | vnf-nameZ\_int |                |                |                |
|                | erface-nameZ   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-i | the ASDC data  | query          | string         |                |
| d              | dictionary     |                |                |                |
|                | widget model.  |                |                |                |
|                | This maps      |                |                |                |
|                | directly to    |                |                |                |
|                | the A&AI       |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| widget-model-v | the ASDC data  | query          | string         |                |
| ersion         | dictionary     |                |                |                |
|                | version of the |                |                |                |
|                | widget         |                |                |                |
|                | model.This     |                |                |                |
|                | maps directly  |                |                |                |
|                | to the A&AI    |                |                |                |
|                | version of the |                |                |                |
|                | widget.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| link-id        | UUID of the    | query          | string         |                |
|                | logical-link,  |                |                |                |
|                | SDNC generates |                |                |                |
|                | this.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| circuit-id     | Circuit id     | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| purpose        | Reason for     | query          | string         |                |
|                | this entity,   |                |                |                |
|                | role it is     |                |                |                |
|                | playing        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/logical-link <#/definitions/logical-link>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-logical-links-logical-link--link-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing logical-link

.. raw:: html

   </div>

.. rubric:: PUT **/network/logical-links/logical-link/{link-name}**
   :name: put-networklogical-linkslogical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

logical-link object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/logical-link <#/definitions/logical-link>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | evc-name, or   |                |                |                |
|                | vnf-nameA\_int |                |                |                |
|                | erface-nameA\_ |                |                |                |
|                | vnf-nameZ\_int |                |                |                |
|                | erface-nameZ   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-logical-links-logical-link--link-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing logical-link

.. raw:: html

   </div>

.. rubric:: DELETE **/network/logical-links/logical-link/{link-name}**
   :name: delete-networklogical-linkslogical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | evc-name, or   |                |                |                |
|                | vnf-nameA\_int |                |                |                |
|                | erface-nameA\_ |                |                |                |
|                | vnf-nameZ\_int |                |                |                |
|                | erface-nameZ   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-logical-links-logical-link--link-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/logical-links/logical-link/{link-name}/relationship-list/relationship**
   :name: put-networklogical-linkslogical-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | evc-name, or   |                |                |                |
|                | vnf-nameA\_int |                |                |                |
|                | erface-nameA\_ |                |                |                |
|                | vnf-nameZ\_int |                |                |                |
|                | erface-nameZ   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-logical-links-logical-link--link-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/logical-links/logical-link/{link-name}/relationship-list/relationship**
   :name: delete-networklogical-linkslogical-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | evc-name, or   |                |                |                |
|                | vnf-nameA\_int |                |                |                |
|                | erface-nameA\_ |                |                |                |
|                | vnf-nameZ\_int |                |                |                |
|                | erface-nameZ   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-multicast-configurations-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns multicast-configurations

.. raw:: html

   </div>

.. rubric:: GET **/network/multicast-configurations**
   :name: get-networkmulticast-configurations
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns multicast-configurations

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/multicast-configurations <#/definitions/multicast-configurations>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns multicast-configuration

.. raw:: html

   </div>

.. rubric:: GET
   **/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}**
   :name: get-networkmulticast-configurationsmulticast-configurationmulticast-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns multicast-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| multicast-conf | Unique id of   | path           | string         |                |
| iguration-id   | multicast      |                |                |                |
|                | configuration. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/multicast-configuration <#/definitions/multicast-configuration>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing multicast-configuration

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}**
   :name: put-networkmulticast-configurationsmulticast-configurationmulticast-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing multicast-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

multicast-configuration object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/multicast-configuration <#/definitions/multicast-configuration>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| multicast-conf | Unique id of   | path           | string         |                |
| iguration-id   | multicast      |                |                |                |
|                | configuration. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing multicast-configuration

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}**
   :name: delete-networkmulticast-configurationsmulticast-configurationmulticast-configuration-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing multicast-configuration

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| multicast-conf | Unique id of   | path           | string         |                |
| iguration-id   | multicast      |                |                |                |
|                | configuration. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship**
   :name: put-networkmulticast-configurationsmulticast-configurationmulticast-configuration-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| multicast-conf | Unique id of   | path           | string         |                |
| iguration-id   | multicast      |                |                |                |
|                | configuration. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-multicast-configurations-multicast-configuration--multicast-configuration-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship**
   :name: delete-networkmulticast-configurationsmulticast-configurationmulticast-configuration-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| multicast-conf | Unique id of   | path           | string         |                |
| iguration-id   | multicast      |                |                |                |
|                | configuration. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-network-policies-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns network-policies

.. raw:: html

   </div>

.. rubric:: GET **/network/network-policies**
   :name: get-networknetwork-policies
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns network-policies

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/network-policies <#/definitions/network-policies>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-network-policies-network-policy--network-policy-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns network-policy

.. raw:: html

   </div>

.. rubric:: GET
   **/network/network-policies/network-policy/{network-policy-id}**
   :name: get-networknetwork-policiesnetwork-policynetwork-policy-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns network-policy

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-policy | UUID           | path           | string         |                |
| -id            | representing   |                |                |                |
|                | unique key to  |                |                |                |
|                | this instance  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-policy | Contrail FQDN  | query          | string         |                |
| -fqdn          | for the policy |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/network-policy <#/definitions/network-policy>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-network-policies-network-policy--network-policy-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing network-policy

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/network-policies/network-policy/{network-policy-id}**
   :name: put-networknetwork-policiesnetwork-policynetwork-policy-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing network-policy

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

network-policy object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/network-policy <#/definitions/network-policy>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-policy | UUID           | path           | string         |                |
| -id            | representing   |                |                |                |
|                | unique key to  |                |                |                |
|                | this instance  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-network-policies-network-policy--network-policy-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing network-policy

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/network-policies/network-policy/{network-policy-id}**
   :name: delete-networknetwork-policiesnetwork-policynetwork-policy-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing network-policy

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-policy | UUID           | path           | string         |                |
| -id            | representing   |                |                |                |
|                | unique key to  |                |                |                |
|                | this instance  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship**
   :name: put-networknetwork-policiesnetwork-policynetwork-policy-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-policy | UUID           | path           | string         |                |
| -id            | representing   |                |                |                |
|                | unique key to  |                |                |                |
|                | this instance  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-network-policies-network-policy--network-policy-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship**
   :name: delete-networknetwork-policiesnetwork-policynetwork-policy-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| network-policy | UUID           | path           | string         |                |
| -id            | representing   |                |                |                |
|                | unique key to  |                |                |                |
|                | this instance  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-newvces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns newvces

.. raw:: html

   </div>

.. rubric:: GET **/network/newvces**
   :name: get-networknewvces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns newvces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/newvces <#/definitions/newvces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-newvces-newvce--vnf-id2--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns newvce

.. raw:: html

   </div>

.. rubric:: GET **/network/newvces/newvce/{vnf-id2}**
   :name: get-networknewvcesnewvcevnf-id2
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns newvce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/newvce <#/definitions/newvce>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-newvces-newvce--vnf-id2--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing newvce

.. raw:: html

   </div>

.. rubric:: PUT **/network/newvces/newvce/{vnf-id2}**
   :name: put-networknewvcesnewvcevnf-id2
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing newvce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

newvce object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/newvce <#/definitions/newvce>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-newvces-newvce--vnf-id2--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing newvce

.. raw:: html

   </div>

.. rubric:: DELETE **/network/newvces/newvce/{vnf-id2}**
   :name: delete-networknewvcesnewvcevnf-id2
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing newvce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET **/network/newvces/newvce/{vnf-id2}/l-interfaces**
   :name: get-networknewvcesnewvcevnf-id2l-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: get-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2l-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/newvces/newvce/{vnf-id2}/relationship-list/relationship**
   :name: put-networknewvcesnewvcevnf-id2relationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-newvces-newvce--vnf-id2--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/newvces/newvce/{vnf-id2}/relationship-list/relationship**
   :name: delete-networknewvcesnewvcevnf-id2relationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id2        | Unique id of   | path           | string         |                |
|                | VNF, can't use |                |                |                |
|                | same attribute |                |                |                |
|                | name right now |                |                |                |
|                | until we       |                |                |                |
|                | promote this   |                |                |                |
|                | new object     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-physical-links-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns physical-links

.. raw:: html

   </div>

.. rubric:: GET **/network/physical-links**
   :name: get-networkphysical-links
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns physical-links

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/physical-links <#/definitions/physical-links>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-physical-links-physical-link--link-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns physical-link

.. raw:: html

   </div>

.. rubric:: GET **/network/physical-links/physical-link/{link-name}**
   :name: get-networkphysical-linksphysical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns physical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | hostnameA\_p-c |                |                |                |
|                | onnection\_nam |                |                |                |
|                | eA\_hostnameZ+ |                |                |                |
|                | p\_connection- |                |                |                |
|                | nameZ          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| circuit-id     | Circuit it     | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/physical-link <#/definitions/physical-link>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-physical-links-physical-link--link-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing physical-link

.. raw:: html

   </div>

.. rubric:: PUT **/network/physical-links/physical-link/{link-name}**
   :name: put-networkphysical-linksphysical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing physical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

physical-link object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/physical-link <#/definitions/physical-link>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | hostnameA\_p-c |                |                |                |
|                | onnection\_nam |                |                |                |
|                | eA\_hostnameZ+ |                |                |                |
|                | p\_connection- |                |                |                |
|                | nameZ          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-physical-links-physical-link--link-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing physical-link

.. raw:: html

   </div>

.. rubric:: DELETE **/network/physical-links/physical-link/{link-name}**
   :name: delete-networkphysical-linksphysical-linklink-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing physical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | hostnameA\_p-c |                |                |                |
|                | onnection\_nam |                |                |                |
|                | eA\_hostnameZ+ |                |                |                |
|                | p\_connection- |                |                |                |
|                | nameZ          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-physical-links-physical-link--link-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/physical-links/physical-link/{link-name}/relationship-list/relationship**
   :name: put-networkphysical-linksphysical-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | hostnameA\_p-c |                |                |                |
|                | onnection\_nam |                |                |                |
|                | eA\_hostnameZ+ |                |                |                |
|                | p\_connection- |                |                |                |
|                | nameZ          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-physical-links-physical-link--link-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/physical-links/physical-link/{link-name}/relationship-list/relationship**
   :name: delete-networkphysical-linksphysical-linklink-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| link-name      | e.g.,          | path           | string         |                |
|                | hostnameA\_p-c |                |                |                |
|                | onnection\_nam |                |                |                |
|                | eA\_hostnameZ+ |                |                |                |
|                | p\_connection- |                |                |                |
|                | nameZ          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns pnfs

.. raw:: html

   </div>

.. rubric:: GET **/network/pnfs**
   :name: get-networkpnfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns pnfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/pnfs <#/definitions/pnfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-pnf--pnf-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns pnf

.. raw:: html

   </div>

.. rubric:: GET **/network/pnfs/pnf/{pnf-name}**
   :name: get-networkpnfspnfpnf-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns pnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/pnf <#/definitions/pnf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-pnf--pnf-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing pnf

.. raw:: html

   </div>

.. rubric:: PUT **/network/pnfs/pnf/{pnf-name}**
   :name: put-networkpnfspnfpnf-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing pnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

pnf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/pnf <#/definitions/pnf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-pnf--pnf-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing pnf

.. raw:: html

   </div>

.. rubric:: DELETE **/network/pnfs/pnf/{pnf-name}**
   :name: delete-networkpnfspnfpnf-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing pnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interfaces

.. raw:: html

   </div>

.. rubric:: GET **/network/pnfs/pnf/{pnf-name}/lag-interfaces**
   :name: get-networkpnfspnfpnf-namelag-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interfaces <#/definitions/lag-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing lag-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

lag-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/lag-interface <#/definitions/lag-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing lag-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-pnfs-pnf--pnf-name--p-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interfaces

.. raw:: html

   </div>

.. rubric:: GET **/network/pnfs/pnf/{pnf-name}/p-interfaces**
   :name: get-networkpnfspnfpnf-namep-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interfaces <#/definitions/p-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interface <#/definitions/p-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing p-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

p-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/p-interface <#/definitions/p-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing p-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-sriov-vf--pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pfs <#/definitions/sriov-pfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: get-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| inv-status     | CANOPI's       | query          | string         |                |
|                | inventory      |                |                |                |
|                | status. Only   |                |                |                |
|                | set with       |                |                |                |
|                | values exactly |                |                |                |
|                | as defined by  |                |                |                |
|                | CANOPI.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pf <#/definitions/sriov-pf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-pf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-pf <#/definitions/sriov-pf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/pnfs/pnf/{pnf-name}/relationship-list/relationship**
   :name: put-networkpnfspnfpnf-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-pnfs-pnf--pnf-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/pnfs/pnf/{pnf-name}/relationship-list/relationship**
   :name: delete-networkpnfspnfpnf-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| pnf-name       | unique name of | path           | string         |                |
|                | Physical       |                |                |                |
|                | Network        |                |                |                |
|                | Function.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-route-table-references-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns route-table-references

.. raw:: html

   </div>

.. rubric:: GET **/network/route-table-references**
   :name: get-networkroute-table-references
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns route-table-references

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/route-table-references <#/definitions/route-table-references>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-route-table-references-route-table-reference--route-table-reference-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns route-table-reference

.. raw:: html

   </div>

.. rubric:: GET
   **/network/route-table-references/route-table-reference/{route-table-reference-id}**
   :name: get-networkroute-table-referencesroute-table-referenceroute-table-reference-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns route-table-reference

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| route-table-re | Route Table    | path           | string         |                |
| ference-id     | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-table-re | FQDN entry in  | query          | string         |                |
| ference-fqdn   | the route      |                |                |                |
|                | table.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/route-table-reference <#/definitions/route-table-reference>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-route-table-references-route-table-reference--route-table-reference-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing route-table-reference

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/route-table-references/route-table-reference/{route-table-reference-id}**
   :name: put-networkroute-table-referencesroute-table-referenceroute-table-reference-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing route-table-reference

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

route-table-reference object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/route-table-reference <#/definitions/route-table-reference>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| route-table-re | Route Table    | path           | string         |                |
| ference-id     | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-route-table-references-route-table-reference--route-table-reference-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing route-table-reference

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/route-table-references/route-table-reference/{route-table-reference-id}**
   :name: delete-networkroute-table-referencesroute-table-referenceroute-table-reference-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing route-table-reference

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| route-table-re | Route Table    | path           | string         |                |
| ference-id     | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship**
   :name: put-networkroute-table-referencesroute-table-referenceroute-table-reference-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| route-table-re | Route Table    | path           | string         |                |
| ference-id     | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-route-table-references-route-table-reference--route-table-reference-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship**
   :name: delete-networkroute-table-referencesroute-table-referenceroute-table-reference-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| route-table-re | Route Table    | path           | string         |                |
| ference-id     | Reference id,  |                |                |                |
|                | UUID assigned  |                |                |                |
|                | to this        |                |                |                |
|                | instance.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-site-pair-sets-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns site-pair-sets

.. raw:: html

   </div>

.. rubric:: GET **/network/site-pair-sets**
   :name: get-networksite-pair-sets
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns site-pair-sets

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/site-pair-sets <#/definitions/site-pair-sets>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns site-pair-set

.. raw:: html

   </div>

.. rubric:: GET
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns site-pair-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/site-pair-set <#/definitions/site-pair-set>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing site-pair-set

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing site-pair-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

site-pair-set object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/site-pair-set <#/definitions/site-pair-set>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing site-pair-set

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing site-pair-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns routing-instances

.. raw:: html

   </div>

.. rubric:: GET
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instances
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns routing-instances

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/routing-instances <#/definitions/routing-instances>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns routing-instance

.. raw:: html

   </div>

.. rubric:: GET
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns routing-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/routing-instance <#/definitions/routing-instance>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing routing-instance

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing routing-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

routing-instance object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/routing-instance <#/definitions/routing-instance>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing routing-instance

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing routing-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-site-pair-sets-site-pair-set--site-pair-set-id--routing-instances-routing-instance--routing-instance-id--site-pairs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns site-pairs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns site-pairs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/site-pairs <#/definitions/site-pairs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns site-pair

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns site-pair

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/site-pair <#/definitions/site-pair>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing site-pair

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing site-pair

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

site-pair object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/site-pair <#/definitions/site-pair>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing site-pair

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing site-pair

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns classes-of-service

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-service
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns classes-of-service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/classes-of-service <#/definitions/classes-of-service>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns class-of-service

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-serviceclass-of-servicecos
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns class-of-service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cos            | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/class-of-service <#/definitions/class-of-service>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing class-of-service

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-serviceclass-of-servicecos
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing class-of-service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

class-of-service object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/class-of-service <#/definitions/class-of-service>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cos            | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing class-of-service

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-serviceclass-of-servicecos
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing class-of-service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cos            | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-serviceclass-of-servicecosrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cos            | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idclasses-of-serviceclass-of-servicecosrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cos            | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networksite-pair-setssite-pair-setsite-pair-set-idrouting-instancesrouting-instancerouting-instance-idsite-pairssite-pairsite-pair-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| site-pair-set- | Unique id of   | path           | string         |                |
| id             | site pair set. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| routing-instan | Unique id of   | path           | string         |                |
| ce-id          | routing        |                |                |                |
|                | instance       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| site-pair-id   | unique         | path           | string         |                |
|                | identifier of  |                |                |                |
|                | probe          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vces

.. raw:: html

   </div>

.. rubric:: GET **/network/vces**
   :name: get-networkvces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vces <#/definitions/vces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vce

.. raw:: html

   </div>

.. rubric:: GET **/network/vces/vce/{vnf-id}**
   :name: get-networkvcesvcevnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vce <#/definitions/vce>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vce

.. raw:: html

   </div>

.. rubric:: PUT **/network/vces/vce/{vnf-id}**
   :name: put-networkvcesvcevnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vce object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vce <#/definitions/vce>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vce

.. raw:: html

   </div>

.. rubric:: DELETE **/network/vces/vce/{vnf-id}**
   :name: delete-networkvcesvcevnf-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vce

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--entitlements-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns entitlements

.. raw:: html

   </div>

.. rubric:: GET **/network/vces/vce/{vnf-id}/entitlements**
   :name: get-networkvcesvcevnf-identitlements
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns entitlements

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/entitlements <#/definitions/entitlements>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns entitlement

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: get-networkvcesvcevnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/entitlement <#/definitions/entitlement>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing entitlement

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: put-networkvcesvcevnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

entitlement object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/entitlement <#/definitions/entitlement>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing entitlement

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}**
   :name: delete-networkvcesvcevnf-identitlementsentitlementgroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing entitlement

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: put-networkvcesvcevnf-identitlementsentitlementgroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--entitlements-entitlement--group-uuid---resource-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: delete-networkvcesvcevnf-identitlementsentitlementgroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the            |                |                |                |
|                | entitlement    |                |                |                |
|                | group the      |                |                |                |
|                | resource comes |                |                |                |
|                | from, should   |                |                |                |
|                | be uuid.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of   | path           | string         |                |
|                | an entitlement |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--licenses-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns licenses

.. raw:: html

   </div>

.. rubric:: GET **/network/vces/vce/{vnf-id}/licenses**
   :name: get-networkvcesvcevnf-idlicenses
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns licenses

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/licenses <#/definitions/licenses>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns license

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: get-networkvcesvcevnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/license <#/definitions/license>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing license

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: put-networkvcesvcevnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

license object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/license <#/definitions/license>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing license

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}**
   :name: delete-networkvcesvcevnf-idlicenseslicensegroup-uuidresource-uuid
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing license

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: put-networkvcesvcevnf-idlicenseslicensegroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--licenses-license--group-uuid---resource-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship**
   :name: delete-networkvcesvcevnf-idlicenseslicensegroup-uuidresource-uuidrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-uuid     | Unique ID for  | path           | string         |                |
|                | the license    |                |                |                |
|                | group the      |                |                |                |
|                | resource       |                |                |                |
|                | belongs to,    |                |                |                |
|                | should be      |                |                |                |
|                | uuid.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-uuid  | Unique ID of a | path           | string         |                |
|                | license        |                |                |                |
|                | resource.      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vces-vce--vnf-id--port-groups-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns port-groups

.. raw:: html

   </div>

.. rubric:: GET **/network/vces/vce/{vnf-id}/port-groups**
   :name: get-networkvcesvcevnf-idport-groups
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns port-groups

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/port-groups <#/definitions/port-groups>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns port-group

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}**
   :name: get-networkvcesvcevnf-idport-groupsport-groupinterface-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns port-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| port-group-id  | Unique ID for  | query          | string         |                |
|                | port group in  |                |                |                |
|                | vmware         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS or         | query          | string         |                |
|                | standard       |                |                |                |
|                | switch name    |                |                |                |
|                | (should be     |                |                |                |
|                | non-null for   |                |                |                |
|                | port groups    |                |                |                |
|                | associated     |                |                |                |
|                | with DVS)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/port-group <#/definitions/port-group>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing port-group

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}**
   :name: put-networkvcesvcevnf-idport-groupsport-groupinterface-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing port-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

port-group object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/port-group <#/definitions/port-group>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing port-group

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}**
   :name: delete-networkvcesvcevnf-idport-groupsport-groupinterface-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing port-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns cvlan-tags

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags**
   :name: get-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tags
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns cvlan-tags

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| port-group-id  | Unique ID for  | query          | string         |                |
|                | port group in  |                |                |                |
|                | vmware         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS or         | query          | string         |                |
|                | standard       |                |                |                |
|                | switch name    |                |                |                |
|                | (should be     |                |                |                |
|                | non-null for   |                |                |                |
|                | port groups    |                |                |                |
|                | associated     |                |                |                |
|                | with DVS)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/cvlan-tags <#/definitions/cvlan-tags>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns cvlan-tag-entry

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}**
   :name: get-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tagscvlan-tag-entrycvlan-tag
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns cvlan-tag-entry

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | See            | path           | integer        |                |
|                | mis-na-virtual |                |                |                |
|                | ization-platfo |                |                |                |
|                | rm.yang        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name       | Name of VNF.   | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-name2      | Alternate name | query          | string         |                |
|                | of VNF.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | query          | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-id     | Unique         | query          | string         |                |
|                | identifier of  |                |                |                |
|                | service, does  |                |                |                |
|                | not strictly   |                |                |                |
|                | map to ASDC    |                |                |                |
|                | services, SOON |                |                |                |
|                | TO BE          |                |                |                |
|                | DEPRECATED.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| regional-resou | Regional way   | query          | string         |                |
| rce-zone       | of organizing  |                |                |                |
|                | pservers,      |                |                |                |
|                | source of      |                |                |                |
|                | truth should   |                |                |                |
|                | define values  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpe-id         | Unique ID of   | query          | string         |                |
|                | VPE connected  |                |                |                |
|                | to this VCE.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| port-group-id  | Unique ID for  | query          | string         |                |
|                | port group in  |                |                |                |
|                | vmware         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| switch-name    | DVS or         | query          | string         |                |
|                | standard       |                |                |                |
|                | switch name    |                |                |                |
|                | (should be     |                |                |                |
|                | non-null for   |                |                |                |
|                | port groups    |                |                |                |
|                | associated     |                |                |                |
|                | with DVS)      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| heat-stack-id  | Heat stack id  | query          | string         |                |
|                | corresponding  |                |                |                |
|                | to this        |                |                |                |
|                | instance,      |                |                |                |
|                | managed by MSO |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/cvlan-tag-entry <#/definitions/cvlan-tag-entry>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing cvlan-tag-entry

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}**
   :name: put-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tagscvlan-tag-entrycvlan-tag
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing cvlan-tag-entry

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

cvlan-tag-entry object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/cvlan-tag-entry <#/definitions/cvlan-tag-entry>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | See            | path           | integer        |                |
|                | mis-na-virtual |                |                |                |
|                | ization-platfo |                |                |                |
|                | rm.yang        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing cvlan-tag-entry

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}**
   :name: delete-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tagscvlan-tag-entrycvlan-tag
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing cvlan-tag-entry

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | See            | path           | integer        |                |
|                | mis-na-virtual |                |                |                |
|                | ization-platfo |                |                |                |
|                | rm.yang        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship**
   :name: put-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tagscvlan-tag-entrycvlan-tagrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | See            | path           | integer        |                |
|                | mis-na-virtual |                |                |                |
|                | ization-platfo |                |                |                |
|                | rm.yang        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--cvlan-tags-cvlan-tag-entry--cvlan-tag--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship**
   :name: delete-networkvcesvcevnf-idport-groupsport-groupinterface-idcvlan-tagscvlan-tag-entrycvlan-tagrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| cvlan-tag      | See            | path           | integer        |                |
|                | mis-na-virtual |                |                |                |
|                | ization-platfo |                |                |                |
|                | rm.yang        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship**
   :name: put-networkvcesvcevnf-idport-groupsport-groupinterface-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--port-groups-port-group--interface-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship**
   :name: delete-networkvcesvcevnf-idport-groupsport-groupinterface-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | Unique ID of   | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vces/vce/{vnf-id}/relationship-list/relationship**
   :name: put-networkvcesvcevnf-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vces-vce--vnf-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vces/vce/{vnf-id}/relationship-list/relationship**
   :name: delete-networkvcesvcevnf-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-id         | Unique id of   | path           | string         |                |
|                | VNF. This is   |                |                |                |
|                | unique across  |                |                |                |
|                | the graph.     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vnfcs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vnfcs

.. raw:: html

   </div>

.. rubric:: GET **/network/vnfcs**
   :name: get-networkvnfcs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vnfcs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vnfcs <#/definitions/vnfcs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vnfcs-vnfc--vnfc-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vnfc

.. raw:: html

   </div>

.. rubric:: GET **/network/vnfcs/vnfc/{vnfc-name}**
   :name: get-networkvnfcsvnfcvnfc-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vnfc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-naming-cod | Short code     | query          | string         |                |
| e              | that is used   |                |                |                |
|                | in naming      |                |                |                |
|                | instances of   |                |                |                |
|                | the item being |                |                |                |
|                | modeled        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-function   | English        | query          | string         |                |
|                | description of |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | resource       |                |                |                |
|                | deployment is  |                |                |                |
|                | providing.     |                |                |                |
|                | Assigned as    |                |                |                |
|                | part of the    |                |                |                |
|                | customization  |                |                |                |
|                | of a resource  |                |                |                |
|                | in a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | prov status of | query          | string         |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| ipaddress-v4-o | Oam V4 vip     | query          | string         |                |
| am-vip         | address of     |                |                |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-notation | Group notation | query          | string         |                |
|                | of VNFC        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vnfc <#/definitions/vnfc>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vnfcs-vnfc--vnfc-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vnfc

.. raw:: html

   </div>

.. rubric:: PUT **/network/vnfcs/vnfc/{vnfc-name}**
   :name: put-networkvnfcsvnfcvnfc-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vnfc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vnfc object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vnfc <#/definitions/vnfc>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vnfcs-vnfc--vnfc-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vnfc

.. raw:: html

   </div>

.. rubric:: DELETE **/network/vnfcs/vnfc/{vnfc-name}**
   :name: delete-networkvnfcsvnfcvnfc-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vnfc

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: get-networkvnfcsvnfcvnfc-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-naming-cod | Short code     | query          | string         |                |
| e              | that is used   |                |                |                |
|                | in naming      |                |                |                |
|                | instances of   |                |                |                |
|                | the item being |                |                |                |
|                | modeled        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-function   | English        | query          | string         |                |
|                | description of |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | resource       |                |                |                |
|                | deployment is  |                |                |                |
|                | providing.     |                |                |                |
|                | Assigned as    |                |                |                |
|                | part of the    |                |                |                |
|                | customization  |                |                |                |
|                | of a resource  |                |                |                |
|                | in a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | prov status of | query          | string         |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| ipaddress-v4-o | Oam V4 vip     | query          | string         |                |
| am-vip         | address of     |                |                |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-notation | Group notation | query          | string         |                |
|                | of VNFC        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: put-networkvnfcsvnfcvnfc-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}**
   :name: delete-networkvnfcsvnfcvnfc-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship**
   :name: put-networkvnfcsvnfcvnfc-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv4-address-list--l3-interface-ipv4-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship**
   :name: delete-networkvnfcsvnfcvnfc-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: get-networkvnfcsvnfcvnfc-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-naming-cod | Short code     | query          | string         |                |
| e              | that is used   |                |                |                |
|                | in naming      |                |                |                |
|                | instances of   |                |                |                |
|                | the item being |                |                |                |
|                | modeled        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| nfc-function   | English        | query          | string         |                |
|                | description of |                |                |                |
|                | function that  |                |                |                |
|                | the specific   |                |                |                |
|                | resource       |                |                |                |
|                | deployment is  |                |                |                |
|                | providing.     |                |                |                |
|                | Assigned as    |                |                |                |
|                | part of the    |                |                |                |
|                | customization  |                |                |                |
|                | of a resource  |                |                |                |
|                | in a service   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | prov status of | query          | string         |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| ipaddress-v4-o | Oam V4 vip     | query          | string         |                |
| am-vip         | address of     |                |                |                |
|                | this vnfc      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| in-maint       |                | query          | boolean        |                |
+----------------+----------------+----------------+----------------+----------------+
| is-closed-loop |                | query          | boolean        |                |
| -disabled      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| group-notation | Group notation | query          | string         |                |
|                | of VNFC        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-invarian | the ASDC model | query          | string         |                |
| t-id           | id for this    |                |                |                |
|                | resource or    |                |                |                |
|                | service model. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | the ASDC model | query          | string         |                |
| id             | version for    |                |                |                |
|                | this resource  |                |                |                |
|                | or service     |                |                |                |
|                | model.         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: put-networkvnfcsvnfcvnfc-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}**
   :name: delete-networkvnfcsvnfcvnfc-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship**
   :name: put-networkvnfcsvnfcvnfc-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--l3-interface-ipv6-address-list--l3-interface-ipv6-address--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship**
   :name: delete-networkvnfcsvnfcvnfc-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship**
   :name: put-networkvnfcsvnfcvnfc-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vnfcs-vnfc--vnfc-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship**
   :name: delete-networkvnfcsvnfcvnfc-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnfc-name      | Unique ID of   | path           | string         |                |
|                | vnfc.          |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpls-pes-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vpls-pes

.. raw:: html

   </div>

.. rubric:: GET **/network/vpls-pes**
   :name: get-networkvpls-pes
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vpls-pes

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vpls-pes <#/definitions/vpls-pes>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpls-pes-vpls-pe--equipment-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vpls-pe

.. raw:: html

   </div>

.. rubric:: GET **/network/vpls-pes/vpls-pe/{equipment-name}**
   :name: get-networkvpls-pesvpls-peequipment-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vpls-pe

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vpls-pe <#/definitions/vpls-pe>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpls-pes-vpls-pe--equipment-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vpls-pe

.. raw:: html

   </div>

.. rubric:: PUT **/network/vpls-pes/vpls-pe/{equipment-name}**
   :name: put-networkvpls-pesvpls-peequipment-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vpls-pe

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vpls-pe object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vpls-pe <#/definitions/vpls-pe>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpls-pes-vpls-pe--equipment-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vpls-pe

.. raw:: html

   </div>

.. rubric:: DELETE **/network/vpls-pes/vpls-pe/{equipment-name}**
   :name: delete-networkvpls-pesvpls-peequipment-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vpls-pe

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interfaces <#/definitions/lag-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns lag-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing lag-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

lag-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/lag-interface <#/definitions/lag-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing lag-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing lag-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-role | Role assigned  | query          | string         |                |
|                | to this        |                |                |                |
|                | Interface,     |                |                |                |
|                | should use     |                |                |                |
|                | values as      |                |                |                |
|                | defined in     |                |                |                |
|                | ECOMP Yang     |                |                |                |
|                | models.        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--lag-interfaces-lag-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namelag-interfaceslag-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | link aggregate |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interfaces <#/definitions/p-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns p-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/p-interface <#/definitions/p-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing p-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

p-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/p-interface <#/definitions/p-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing p-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interfaces

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfaces
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interfaces <#/definitions/l-interfaces>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l-interface

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l-interface <#/definitions/l-interface>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l-interface

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l-interface object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l-interface <#/definitions/l-interface>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l-interface

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-name
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--sriov-vfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vfs <#/definitions/sriov-vfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-vf

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-filter | This metadata  | query          | string         |                |
|                | provides       |                |                |                |
|                | option to      |                |                |                |
|                | specify list   |                |                |                |
|                | of VLAN        |                |                |                |
|                | filters        |                |                |                |
|                | applied on VF  |                |                |                |
|                | to pass the    |                |                |                |
|                | traffic to VM. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-mac-filter  | When MAC       | query          | string         |                |
|                | filters are    |                |                |                |
|                | specified,     |                |                |                |
|                | VF-agent       |                |                |                |
|                | service        |                |                |                |
|                | configures VFs |                |                |                |
|                | to do MAC      |                |                |                |
|                | level          |                |                |                |
|                | filtering      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vf-vlan-strip  | When this      | query          | boolean        |                |
|                | field is set   |                |                |                |
|                | to true, VF    |                |                |                |
|                | will           |                |                |                |
|                | configured to  |                |                |                |
|                | strip the      |                |                |                |
|                | outer TAG      |                |                |                |
|                | before the     |                |                |                |
|                | traffic is     |                |                |                |
|                | passed to VM.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-vf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-vf <#/definitions/sriov-vf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-vf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namesriov-vfssriov-vfpci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pci-id         | PCI ID used to | path           | string         |                |
|                | identify the   |                |                |                |
|                | sriov-vf       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlans

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlans
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlans

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlans <#/definitions/vlans>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vlan

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vlan <#/definitions/vlan>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vlan

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vlan object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vlan <#/definitions/vlan>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--l-interfaces-l-interface--interface-name--vlans-vlan--vlan-interface--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vlan

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interface
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv4-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv4-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv4-address-listl3-interface-ipv4-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv4-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-id   | ID of          | query          | string         |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| macaddr        | MAC address    | query          | string         |                |
|                | for the        |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| network-name   | Name of the    | query          | string         |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-key        | This indicates | query          | string         |                |
|                | the customers  |                |                |                |
|                | VPN ID         |                |                |                |
|                | associated     |                |                |                |
|                | with this vlan |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-id-inner  | Inner VLAN tag | query          | integer        |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-networ | Neutron        | query          | string         |                |
| k-id           | network id of  |                |                |                |
|                | the interface  |                |                |                |
|                | that address   |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| neutron-subnet | Neutron id of  | query          | string         |                |
| -id            | subnet that    |                |                |                |
|                | address        |                |                |                |
|                | belongs to     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

l3-interface-ipv6-address-list object that needs to be created or
updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-address
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing l3-interface-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacel3-interface-ipv6-address-listl3-interface-ipv6-addressrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| l3-interface-i | IP address     | path           | string         |                |
| pv6-address    |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namel-interfacesl-interfaceinterface-namevlansvlanvlan-interfacerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name given to  | path           | string         |                |
|                | the interface  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vlan-interface | String that    | path           | string         |                |
|                | identifies the |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pfs

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfs
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pfs

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pfs <#/definitions/sriov-pfs>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns sriov-pf

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: get-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this VNF by    |                |                |                |
|                | BAU Service    |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| prov-status    | Trigger for    | query          | string         |                |
|                | operational    |                |                |                |
|                | monitoring of  |                |                |                |
|                | this resource  |                |                |                |
|                | by Service     |                |                |                |
|                | Assurance      |                |                |                |
|                | systems.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/sriov-pf <#/definitions/sriov-pf>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

sriov-pf object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/sriov-pf <#/definitions/sriov-pf>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing sriov-pf

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing sriov-pf

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--p-interfaces-p-interface--interface-name--sriov-pfs-sriov-pf--pf-pci-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namep-interfacesp-interfaceinterface-namesriov-pfssriov-pfpf-pci-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| interface-name | Name that      | path           | string         |                |
|                | identifies the |                |                |                |
|                | physical       |                |                |                |
|                | interface      |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| pf-pci-id      | Identifier for | path           | string         |                |
|                | the sriov-pf   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship**
   :name: put-networkvpls-pesvpls-peequipment-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpls-pes-vpls-pe--equipment-name--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship**
   :name: delete-networkvpls-pesvpls-peequipment-namerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| equipment-name |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpn-bindings-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vpn-bindings

.. raw:: html

   </div>

.. rubric:: GET **/network/vpn-bindings**
   :name: get-networkvpn-bindings
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vpn-bindings

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vpn-bindings <#/definitions/vpn-bindings>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vpn-binding

.. raw:: html

   </div>

.. rubric:: GET **/network/vpn-bindings/vpn-binding/{vpn-id}**
   :name: get-networkvpn-bindingsvpn-bindingvpn-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vpn-binding

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-name       | VPN Name       | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-type       | Type of the    | query          | string         |                |
|                | vpn, should be |                |                |                |
|                | taken from     |                |                |                |
|                | enumerated/val |                |                |                |
|                | id             |                |                |                |
|                | values         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vpn-binding <#/definitions/vpn-binding>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vpn-binding

.. raw:: html

   </div>

.. rubric:: PUT **/network/vpn-bindings/vpn-binding/{vpn-id}**
   :name: put-networkvpn-bindingsvpn-bindingvpn-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vpn-binding

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vpn-binding object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vpn-binding <#/definitions/vpn-binding>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-vpn-bindings-vpn-binding--vpn-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vpn-binding

.. raw:: html

   </div>

.. rubric:: DELETE **/network/vpn-bindings/vpn-binding/{vpn-id}**
   :name: delete-networkvpn-bindingsvpn-bindingvpn-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vpn-binding

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship**
   :name: put-networkvpn-bindingsvpn-bindingvpn-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship**
   :name: delete-networkvpn-bindingsvpn-bindingvpn-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns route-targets

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets**
   :name: get-networkvpn-bindingsvpn-bindingvpn-idroute-targets
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns route-targets

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-name       | VPN Name       | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-type       | Type of the    | query          | string         |                |
|                | vpn, should be |                |                |                |
|                | taken from     |                |                |                |
|                | enumerated/val |                |                |                |
|                | id             |                |                |                |
|                | values         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/route-targets <#/definitions/route-targets>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns route-target

.. raw:: html

   </div>

.. rubric:: GET
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}**
   :name: get-networkvpn-bindingsvpn-bindingvpn-idroute-targetsroute-targetglobal-route-targetroute-target-role
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns route-target

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| global-route-t | Number used to | path           | string         |                |
| arget          | identify an    |                |                |                |
|                | RT, globally   |                |                |                |
|                | unique in the  |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-target-r | Role assigned  | path           | string         |                |
| ole            | to this route  |                |                |                |
|                | target         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-name       | VPN Name       | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| vpn-type       | Type of the    | query          | string         |                |
|                | vpn, should be |                |                |                |
|                | taken from     |                |                |                |
|                | enumerated/val |                |                |                |
|                | id             |                |                |                |
|                | values         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/route-target <#/definitions/route-target>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing route-target

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}**
   :name: put-networkvpn-bindingsvpn-bindingvpn-idroute-targetsroute-targetglobal-route-targetroute-target-role
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing route-target

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

route-target object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/route-target <#/definitions/route-target>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| global-route-t | Number used to | path           | string         |                |
| arget          | identify an    |                |                |                |
|                | RT, globally   |                |                |                |
|                | unique in the  |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-target-r | Role assigned  | path           | string         |                |
| ole            | to this route  |                |                |                |
|                | target         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing route-target

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}**
   :name: delete-networkvpn-bindingsvpn-bindingvpn-idroute-targetsroute-targetglobal-route-targetroute-target-role
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing route-target

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| global-route-t | Number used to | path           | string         |                |
| arget          | identify an    |                |                |                |
|                | RT, globally   |                |                |                |
|                | unique in the  |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-target-r | Role assigned  | path           | string         |                |
| ole            | to this route  |                |                |                |
|                | target         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship**
   :name: put-networkvpn-bindingsvpn-bindingvpn-idroute-targetsroute-targetglobal-route-targetroute-target-rolerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| global-route-t | Number used to | path           | string         |                |
| arget          | identify an    |                |                |                |
|                | RT, globally   |                |                |                |
|                | unique in the  |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-target-r | Role assigned  | path           | string         |                |
| ole            | to this route  |                |                |                |
|                | target         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-vpn-bindings-vpn-binding--vpn-id--route-targets-route-target--global-route-target---route-target-role--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship**
   :name: delete-networkvpn-bindingsvpn-bindingvpn-idroute-targetsroute-targetglobal-route-targetroute-target-rolerelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vpn-id         | VPN ID,        | path           | string         |                |
|                | globally       |                |                |                |
|                | unique within  |                |                |                |
|                | A&AI           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| global-route-t | Number used to | path           | string         |                |
| arget          | identify an    |                |                |                |
|                | RT, globally   |                |                |                |
|                | unique in the  |                |                |                |
|                | network        |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| route-target-r | Role assigned  | path           | string         |                |
| ole            | to this route  |                |                |                |
|                | target         |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-zones-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns zones

.. raw:: html

   </div>

.. rubric:: GET **/network/zones**
   :name: get-networkzones
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns zones

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/zones <#/definitions/zones>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-zones-zone--zone-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns zone

.. raw:: html

   </div>

.. rubric:: GET **/network/zones/zone/{zone-id}**
   :name: get-networkzoneszonezone-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| zone-id        | Code assigned  | path           | string         |                |
|                | by AIC to the  |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| design-type    | Design of zone | query          | string         |                |
|                | [Medium/Large? |                |                |                |
|                | ]              |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| zone-context   | Context of     | query          | string         |                |
|                | zone           |                |                |                |
|                | [production/te |                |                |                |
|                | st]            |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/zone <#/definitions/zone>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-zones-zone--zone-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing zone

.. raw:: html

   </div>

.. rubric:: PUT **/network/zones/zone/{zone-id}**
   :name: put-networkzoneszonezone-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

zone object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/zone <#/definitions/zone>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| zone-id        | Code assigned  | path           | string         |                |
|                | by AIC to the  |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--network-zones-zone--zone-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing zone

.. raw:: html

   </div>

.. rubric:: DELETE **/network/zones/zone/{zone-id}**
   :name: delete-networkzoneszonezone-id
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing zone

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| zone-id        | Code assigned  | path           | string         |                |
|                | by AIC to the  |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-zones-zone--zone-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/network/zones/zone/{zone-id}/relationship-list/relationship**
   :name: put-networkzoneszonezone-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| zone-id        | Code assigned  | path           | string         |                |
|                | by AIC to the  |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--network-zones-zone--zone-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/network/zones/zone/{zone-id}/relationship-list/relationship**
   :name: delete-networkzoneszonezone-idrelationship-listrelationship
   :class: panel-title

Tags: `Network <#tag-Network>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| zone-id        | Code assigned  | path           | string         |                |
|                | by AIC to the  |                |                |                |
|                | zone           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--service-design-and-creation-models-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns models

.. raw:: html

   </div>

.. rubric:: GET **/service-design-and-creation/models**
   :name: get-service-design-and-creationmodels
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns models

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/models <#/definitions/models>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model <#/definitions/model>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing model

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing model

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

model object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/model <#/definitions/model>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing model

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing model

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-vers

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-vers
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-vers

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-vers <#/definitions/model-vers>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-ver

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-ver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-ver <#/definitions/model-ver>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing model-ver

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing model-ver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

model-ver object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/model-ver <#/definitions/model-ver>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing model-ver

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing model-ver

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadata

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmetadata
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadata

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadata <#/definitions/metadata>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns metadatum

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmetadatametadatummetaname
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/metadatum <#/definitions/metadatum>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing metadatum

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmetadatametadatummetaname
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

metadatum object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/metadatum <#/definitions/metadatum>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--metadata-metadatum--metaname--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing metadatum

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmetadatametadatummetaname
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing metadatum

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| metaname       |                | path           | string         |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-elements

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elements
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-elements

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-elements <#/definitions/model-elements>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-element

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-element <#/definitions/model-element>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing model-element

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing model-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

model-element object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/model-element <#/definitions/model-element>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--model-elements-model-element--model-element-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing model-element

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing model-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-constraints

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraints
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-constraints

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-constraints <#/definitions/model-constraints>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns model-constraint

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns model-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/model-constraint <#/definitions/model-constraint>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing model-constraint

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing model-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

model-constraint object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/model-constraint <#/definitions/model-constraint>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing model-constraint

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing model-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns constrained-element-sets

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-sets
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns constrained-element-sets

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/constrained-element-sets <#/definitions/constrained-element-sets>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns constrained-element-set

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns constrained-element-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/constrained-element-set <#/definitions/constrained-element-set>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing constrained-element-set

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing constrained-element-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

constrained-element-set object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/constrained-element-set <#/definitions/constrained-element-set>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing constrained-element-set

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing constrained-element-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns element-choice-sets

.. raw:: html

   </div>

.. rubric:: GET
   **/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**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-sets
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns element-choice-sets

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/element-choice-sets <#/definitions/element-choice-sets>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns element-choice-set

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-setselement-choice-setelement-choice-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns element-choice-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| element-choice |                | path           | string         |                |
| -set-uuid      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-type     | Type of the    | query          | string         |                |
|                | model, e.g.,   |                |                |                |
|                | service,       |                |                |                |
|                | resource,      |                |                |                |
|                | widget, etc.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-name     | Name of the    | query          | string         |                |
|                | model, which   |                |                |                |
|                | can change     |                |                |                |
|                | from version   |                |                |                |
|                | to version.    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version  | Version        | query          | string         |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/element-choice-set <#/definitions/element-choice-set>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing element-choice-set

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-setselement-choice-setelement-choice-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing element-choice-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

element-choice-set object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/element-choice-set <#/definitions/element-choice-set>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| element-choice |                | path           | string         |                |
| -set-uuid      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing element-choice-set

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-setselement-choice-setelement-choice-set-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing element-choice-set

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| element-choice |                | path           | string         |                |
| -set-uuid      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-setselement-choice-setelement-choice-set-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| element-choice |                | path           | string         |                |
| -set-uuid      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidelement-choice-setselement-choice-setelement-choice-set-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| element-choice |                | path           | string         |                |
| -set-uuid      |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidmodel-constraintsmodel-constraintmodel-constraint-uuidconstrained-element-setsconstrained-element-setconstrained-element-set-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-constrai |                | path           | string         |                |
| nt-uuid        |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| constrained-el |                | path           | string         |                |
| ement-set-uuid |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idmodel-elementsmodel-elementmodel-element-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-element- |                | path           | string         |                |
| uuid           |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--model-vers-model-ver--model-version-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idmodel-versmodel-vermodel-version-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| model-version- | Unique         | path           | string         |                |
| id             | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to one version |                |                |                |
|                | of a model in  |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship**
   :name: put-service-design-and-creationmodelsmodelmodel-invariant-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-models-model--model-invariant-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship**
   :name: delete-service-design-and-creationmodelsmodelmodel-invariant-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| model-invarian | Unique         | path           | string         |                |
| t-id           | identifier     |                |                |                |
|                | corresponding  |                |                |                |
|                | to the main    |                |                |                |
|                | definition of  |                |                |                |
|                | a model in     |                |                |                |
|                | ASDC           |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--service-design-and-creation-named-queries-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns named-queries

.. raw:: html

   </div>

.. rubric:: GET **/service-design-and-creation/named-queries**
   :name: get-service-design-and-creationnamed-queries
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns named-queries

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/named-queries <#/definitions/named-queries>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns named-query

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns named-query

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/named-query <#/definitions/named-query>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing named-query

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing named-query

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

named-query object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/named-query <#/definitions/named-query>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing named-query

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing named-query

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns named-query-elements

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elements
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns named-query-elements

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/named-query-elements <#/definitions/named-query-elements>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns named-query-element

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns named-query-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/named-query-element <#/definitions/named-query-element>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing named-query-element

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing named-query-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

named-query-element object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/named-query-element <#/definitions/named-query-element>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing named-query-element

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing named-query-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--property-constraints-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns property-constraints

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidproperty-constraints
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns property-constraints

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/property-constraints <#/definitions/property-constraints>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns property-constraint

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidproperty-constraintsproperty-constraintproperty-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns property-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| property-const |                | path           | string         |                |
| raint-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/property-constraint <#/definitions/property-constraint>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing property-constraint

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidproperty-constraintsproperty-constraintproperty-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing property-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

property-constraint object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/property-constraint <#/definitions/property-constraint>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| property-const |                | path           | string         |                |
| raint-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing property-constraint

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidproperty-constraintsproperty-constraintproperty-constraint-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing property-constraint

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| property-const |                | path           | string         |                |
| raint-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--related-lookups-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns related-lookups

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookups
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns related-lookups

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/related-lookups <#/definitions/related-lookups>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns related-lookup

.. raw:: html

   </div>

.. rubric:: GET
   **/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}**
   :name: get-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookupsrelated-lookuprelated-lookup-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns related-lookup

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| related-lookup |                | path           | string         |                |
| -uuid          |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-na |                | query          | string         |                |
| me             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/related-lookup <#/definitions/related-lookup>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing related-lookup

.. raw:: html

   </div>

.. rubric:: PUT
   **/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}**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookupsrelated-lookuprelated-lookup-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing related-lookup

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

related-lookup object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/related-lookup <#/definitions/related-lookup>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| related-lookup |                | path           | string         |                |
| -uuid          |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing related-lookup

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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}**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookupsrelated-lookuprelated-lookup-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing related-lookup

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| related-lookup |                | path           | string         |                |
| -uuid          |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/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**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookupsrelated-lookuprelated-lookup-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| related-lookup |                | path           | string         |                |
| -uuid          |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--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-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/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**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelated-lookupsrelated-lookuprelated-lookup-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| related-lookup |                | path           | string         |                |
| -uuid          |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--named-query-elements-named-query-element--named-query-element-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidnamed-query-elementsnamed-query-elementnamed-query-element-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| named-query-el |                | path           | string         |                |
| ement-uuid     |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship**
   :name: put-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-named-queries-named-query--named-query-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship**
   :name: delete-service-design-and-creationnamed-queriesnamed-querynamed-query-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| named-query-uu |                | path           | string         |                |
| id             |                |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-capabilities

.. raw:: html

   </div>

.. rubric:: GET **/service-design-and-creation/service-capabilities**
   :name: get-service-design-and-creationservice-capabilities
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-capabilities

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-capabilities <#/definitions/service-capabilities>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service-capability

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}**
   :name: get-service-design-and-creationservice-capabilitiesservice-capabilityservice-typevnf-type
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service-capability

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-type   | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | path           | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service-capability <#/definitions/service-capability>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing service-capability

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}**
   :name: put-service-design-and-creationservice-capabilitiesservice-capabilityservice-typevnf-type
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing service-capability

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

service-capability object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/service-capability <#/definitions/service-capability>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-type   | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | path           | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing service-capability

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}**
   :name: delete-service-design-and-creationservice-capabilitiesservice-capabilityservice-typevnf-type
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing service-capability

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-type   | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | path           | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship**
   :name: put-service-design-and-creationservice-capabilitiesservice-capabilityservice-typevnf-typerelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-type   | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | path           | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-service-capabilities-service-capability--service-type---vnf-type--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship**
   :name: delete-service-design-and-creationservice-capabilitiesservice-capabilityservice-typevnf-typerelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-type   | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| vnf-type       | String         | path           | string         |                |
|                | capturing type |                |                |                |
|                | of vnf, that   |                |                |                |
|                | was intended   |                |                |                |
|                | to identify    |                |                |                |
|                | the ASDC       |                |                |                |
|                | resource. This |                |                |                |
|                | field has been |                |                |                |
|                | overloaded in  |                |                |                |
|                | service-specif |                |                |                |
|                | ic             |                |                |                |
|                | ways and       |                |                |                |
|                | clients should |                |                |                |
|                | expect changes |                |                |                |
|                | to occur in    |                |                |                |
|                | the future to  |                |                |                |
|                | this field as  |                |                |                |
|                | ECOMP matures. |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--service-design-and-creation-services-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns services

.. raw:: html

   </div>

.. rubric:: GET **/service-design-and-creation/services**
   :name: get-service-design-and-creationservices
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns services

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/services <#/definitions/services>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-services-service--service-id--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns service

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/services/service/{service-id}**
   :name: get-service-design-and-creationservicesserviceservice-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-id     | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| service-descri | Description of | query          | string         |                |
| ption          | the service    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/service <#/definitions/service>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-services-service--service-id--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing service

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/services/service/{service-id}**
   :name: put-service-design-and-creationservicesserviceservice-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

service object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/service <#/definitions/service>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-id     | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-services-service--service-id--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing service

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/services/service/{service-id}**
   :name: delete-service-design-and-creationservicesserviceservice-id
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing service

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-id     | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/services/service/{service-id}/relationship-list/relationship**
   :name: put-service-design-and-creationservicesserviceservice-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-id     | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-services-service--service-id--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/services/service/{service-id}/relationship-list/relationship**
   :name: delete-service-design-and-creationservicesserviceservice-idrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| service-id     | This gets      | path           | string         |                |
|                | defined by     |                |                |                |
|                | others to      |                |                |                |
|                | provide a      |                |                |                |
|                | unique ID for  |                |                |                |
|                | the service,   |                |                |                |
|                | we accept what |                |                |                |
|                | is sent.       |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="operation--service-design-and-creation-vnf-images-get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vnf-images

.. raw:: html

   </div>

.. rubric:: GET **/service-design-and-creation/vnf-images**
   :name: get-service-design-and-creationvnf-images
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vnf-images

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vnf-images <#/definitions/vnf-images>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--get"
   class="swagger--panel-operation-get panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

returns vnf-image

.. raw:: html

   </div>

.. rubric:: GET
   **/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}**
   :name: get-service-design-and-creationvnf-imagesvnf-imagevnf-image-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

returns vnf-image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-image-uuid | Unique ID of   | path           | string         |                |
|                | this asset     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application    | The            | query          | string         |                |
|                | application    |                |                |                |
|                | that the image |                |                |                |
|                | instantiates.  |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The vendor of  | query          | string         |                |
| ndor           | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| application-ve | The version of | query          | string         |                |
| rsion          | the            |                |                |                |
|                | application.   |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 200 OK
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    successful operation

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       <div class="panel panel-definition">

    .. raw:: html

       <div class="panel-body">

    `/vnf-image <#/definitions/vnf-image>`__

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

create or update an existing vnf-image

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}**
   :name: put-service-design-and-creationvnf-imagesvnf-imagevnf-image-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

create or update an existing vnf-image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

vnf-image object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/vnf-image <#/definitions/vnf-image>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-image-uuid | Unique ID of   | path           | string         |                |
|                | this asset     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing vnf-image

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}**
   :name: delete-service-design-and-creationvnf-imagesvnf-imagevnf-image-uuid
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing vnf-image

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-image-uuid | Unique ID of   | path           | string         |                |
|                | this asset     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+
| resource-versi | resource-versi | query          | string         |                |
| on             | on             |                |                |                |
|                | for            |                |                |                |
|                | concurrency    |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-put"
   class="swagger--panel-operation-put panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

see node definition for valid relationships

.. raw:: html

   </div>

.. rubric:: PUT
   **/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship**
   :name: put-service-design-and-creationvnf-imagesvnf-imagevnf-image-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

see node definition for valid relationships

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   <div class="row">

.. raw:: html

   <div class="col-md-6">

relationship object that needs to be created or updated

.. raw:: html

   </div>

.. raw:: html

   <div class="col-md-6 sw-request-model">

.. raw:: html

   <div class="panel panel-definition">

.. raw:: html

   <div class="panel-body">

`/relationship <#/definitions/relationship>`__

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-image-uuid | Unique ID of   | path           | string         |                |
|                | this asset     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div
   id="operation--service-design-and-creation-vnf-images-vnf-image--vnf-image-uuid--relationship-list-relationship-delete"
   class="swagger--panel-operation-delete panel">

.. raw:: html

   <div class="panel-heading">

.. raw:: html

   <div class="operation-summary">

delete an existing relationship

.. raw:: html

   </div>

.. rubric:: DELETE
   **/service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship**
   :name: delete-service-design-and-creationvnf-imagesvnf-imagevnf-image-uuidrelationship-listrelationship
   :class: panel-title

Tags: `ServiceDesignAndCreation <#tag-ServiceDesignAndCreation>`__

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section sw-operation-description">

delete an existing relationship

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-body">

application/json application/xml

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-request-params">

+----------------+----------------+----------------+----------------+----------------+
| vnf-image-uuid | Unique ID of   | path           | string         |                |
|                | this asset     |                |                |                |
+----------------+----------------+----------------+----------------+----------------+

.. raw:: html

   </div>

.. raw:: html

   <div class="section sw-responses">

application/json application/xml

 default
    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-12">

    Response codes found in `response codes <https://wiki.onap.org/>`__.

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       <div class="row">

    .. raw:: html

       <div class="col-md-6 sw-response-model">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. rubric:: Schema definitions
   :name: schema-definitions

.. raw:: html

   <div id="definition-action" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ action: object
   :name: action-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 action-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 action-data: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `action-data <#/definitions/action-data>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-action-data" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ action-data: object
   :name: action-data-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-actions" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ actions: object
   :name: actions-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

APIs that are more action related than REST (e.g., notify, update).

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 update: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `update <#/definitions/update>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 notify: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `notify <#/definitions/notify>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-allotted-resource"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ allotted-resource: object
   :name: allotted-resource-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Represents a slice or partial piece of a resource that gets separately
allotted

.. rubric:: Related Nodes
   :name: related-nodes

-  TO generic-vnf (Many2Many)
-  TO l3-network (Many2Many)
-  TO instance-group (Many2Many)
-  TO network-policy (One2One)
-  TO vlan (Many2Many)
-  TO l-interface (One2Many)
-  TO tunnel-xconnect (comprises allotted-resource, One2One)
-  TO vpn-binding (Many2Many)
-  TO allotted-resource (One2One)
-  FROM configuration
-  FROM service-instance (is composed of allotted-resource)
-  FROM service-instance
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 id: string
    Allotted Resource id UUID assigned to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 description: string
    The descriptive information assigned to this allotted resource
    instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    Link back to more information in the controller

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 type: string
    Generic description of the type of allotted resource.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 role: string
    role in the network that this resource will be providing.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 tunnel-xconnects: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `tunnel-xconnect <#/definitions/tunnel-xconnect>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-allotted-resources"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ allotted-resources: object
   :name: allotted-resources-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This object is used to store slices of services being offered

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 allotted-resource: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `allotted-resource <#/definitions/allotted-resource>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-availability-zone"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ availability-zone: object
   :name: availability-zone-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Availability zone, a collection of compute hosts/pservers

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2Many)
-  TO service-capability (Many2Many)
-  FROM cloud-region (is composed of availability-zone)
-  FROM ctag-pool
-  FROM dvs-switch
-  FROM generic-vnf
-  FROM pserver
-  FROM vce

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 availability-zone-name: string
    Name of the availability zone. Unique across a cloud region

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 hypervisor-type: string
    Type of hypervisor. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    State that indicates whether the availability zone should be used,
    etc. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-availability-zones"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ availability-zones: object
   :name: availability-zones-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of availability zones

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 availability-zone: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `availability-zone <#/definitions/availability-zone>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-az-and-dvs-switches"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ az-and-dvs-switches: object
   :name: az-and-dvs-switches-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 dvs-switches: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `dvs-switches <#/definitions/dvs-switches>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 availability-zone: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `availability-zone <#/definitions/availability-zone>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-business" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ business: object
   :name: business-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Namespace for business related constructs

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 connectors: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `connector <#/definitions/connector>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 customers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `customer <#/definitions/customer>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lines-of-business: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `line-of-business <#/definitions/line-of-business>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 owning-entities: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `owning-entity <#/definitions/owning-entity>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 platforms: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `platform <#/definitions/platform>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 projects: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `project <#/definitions/project>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-class-of-service" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ class-of-service: object
   :name: class-of-service-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM site-pair (is composed of class-of-service)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 cos: string
    unique identifier of probe

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 probe-id: string
    identifier of probe

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 probe-type: string
    type of probe

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-classes-of-service"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ classes-of-service: object
   :name: classes-of-service-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

class-of-service of probe

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 class-of-service: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `class-of-service <#/definitions/class-of-service>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-cloud-infrastructure"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ cloud-infrastructure: object
   :name: cloud-infrastructure-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Namespace for cloud infrastructure.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 complexes: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `complex <#/definitions/complex>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 cloud-regions: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `cloud-region <#/definitions/cloud-region>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 network-profiles: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `network-profile <#/definitions/network-profile>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 pservers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `pserver <#/definitions/pserver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 virtual-data-centers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `virtual-data-center <#/definitions/virtual-data-center>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-cloud-region" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ cloud-region: object
   :name: cloud-region-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

cloud-region designates an installation of a cloud cluster or region or
instantiation.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO esr-system-info (comprises cloud-region, One2Many)
-  TO complex (Many2One)
-  TO l3-network (Many2Many)
-  TO tenant (comprises cloud-region, One2Many)
-  TO image (comprises cloud-region, One2Many)
-  TO flavor (comprises cloud-region, One2Many)
-  TO availability-zone (comprises cloud-region, One2Many)
-  TO oam-network (comprises cloud-region, One2Many)
-  TO dvs-switch (comprises cloud-region, One2Many)
-  TO volume-group (comprises cloud-region, One2Many)
-  TO group-assignment (comprises cloud-region, One2Many)
-  TO snapshot (comprises cloud-region, One2Many)
-  TO zone (Many2One)
-  TO vip-ipv4-address-list (comprises cloud-region, One2Many)
-  TO vip-ipv6-address-list (comprises cloud-region, One2Many)
-  FROM pserver
-  FROM logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 cloud-owner: string
    Identifies the vendor and cloud name. First part of composite key
    should be formatted as vendor-cloudname

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-region-id: string
    Identifier used by the vendor for the region. Second part of
    composite key

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-type: string
    Type of the cloud (e.g., openstack)

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 owner-defined-type: string
    Cloud-owner defined type indicator (e.g., dcp, lcp)

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-region-version: string
    Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT
    UP TO DATE.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 identity-url: string
    URL of the keystone identity service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-zone: string
    Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY
    POPULATED.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 complex-name: string
    complex name for cloud-region instance. NOTE - THIS FIELD IS NOT
    CORRECTLY POPULATED.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 sriov-automation: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-extra-info: string
    ESR inputs extra information about the VIM or Cloud which will be
    decoded by MultiVIM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-epa-caps: string
    MultiVIM will discover and expose EPA capabilities.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 volume-groups: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `volume-group <#/definitions/volume-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 tenants: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `tenant <#/definitions/tenant>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 flavors: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `flavor <#/definitions/flavor>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 group-assignments: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `group-assignment <#/definitions/group-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 snapshots: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `snapshot <#/definitions/snapshot>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 images: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `image <#/definitions/image>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 dvs-switches: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `dvs-switch <#/definitions/dvs-switch>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 oam-networks: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `oam-network <#/definitions/oam-network>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 availability-zones: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `availability-zone <#/definitions/availability-zone>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 esr-system-info-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vip-ipv4-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vip-ipv4-address-list <#/definitions/vip-ipv4-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vip-ipv6-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vip-ipv6-address-list <#/definitions/vip-ipv6-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-cloud-regions" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ cloud-regions: object
   :name: cloud-regions-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 cloud-region: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `cloud-region <#/definitions/cloud-region>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-complex" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ complex: object
   :name: complex-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of physical locations that can house cloud-regions.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO ctag-pool (comprises complex, Many2Many)
-  TO l3-network (Many2Many)
-  FROM availability-zone
-  FROM cloud-region
-  FROM oam-network
-  FROM pserver
-  FROM pnf
-  FROM vce
-  FROM vpls-pe
-  FROM volume-group
-  FROM zone
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 physical-location-id: string
    Unique identifier for physical location, e.g., CLLI

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 data-center-code: string
    Data center code which can be an alternate way to identify a complex

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 complex-name: string
    Gamma complex name for LCP instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 identity-url: string
    URL of the keystone identity service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 physical-location-type: string
    Type, e.g., central office, data center.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 street1: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 street2: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 city: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 state: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 postal-code: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 country: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 region: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 latitude: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 longitude: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 elevation: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 lata: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ctag-pools: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ctag-pool <#/definitions/ctag-pool>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-complexes" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ complexes: object
   :name: complexes-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of physical locations that can house cloud-regions.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 complex: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `complex <#/definitions/complex>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-configuration" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ configuration: object
   :name: configuration-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Port Mirror Configuration.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO logical-link (One2Many)
-  TO metadatum (comprises configuration, One2Many)
-  TO allotted-resource (One2One)
-  FROM service-instance
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 management-option: string
    Indicates the entity that will manage this feature. Could be an
    organization or the name of the application as well.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 configuration-id: string
    UUID assigned to configuration.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 configuration-name: string
    Name of the configuration.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 configuration-type: string
    port-mirroring-configuration.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 configuration-sub-type: string
    vprobe, pprobe.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of the configuration.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 configuration-selflink: string
    URL to endpoint where AAI can get more details from SDN-GC.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-customization-id: string
    id of the configuration used to customize the resource

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship-list <#/definitions/relationship-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 metadata: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadata <#/definitions/metadata>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-configurations" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ configurations: object
   :name: configurations-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of configurations

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 configuration: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `configuration <#/definitions/configuration>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-connector" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ connector: object
   :name: connector-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of resource instances used to connect a variety of disparate
inventory widgets

.. rubric:: Related Nodes
   :name: related-nodes

-  TO virtual-data-center (Many2Many)
-  TO metadatum (comprises connector, Many2Many)
-  FROM service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 resource-instance-id: string
    Unique id of resource instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 metadata: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadatum <#/definitions/metadatum>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-connectors" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ connectors: object
   :name: connectors-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of resource instances used to connect a variety of disparate
inventory widgets

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 connector: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `connector <#/definitions/connector>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-constrained-element-set"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ constrained-element-set: object
   :name: constrained-element-set-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This is how we would capture constraints defining allowed sets of
elements.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO element-choice-set (comprises constrained-element-set, One2Many)
-  FROM model-element (is composed of constrained-element-set)
-  FROM model-constraint (is composed of constrained-element-set)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 constrained-element-set-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 constraint-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 check-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 element-choice-sets: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `element-choice-set <#/definitions/element-choice-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-constrained-element-sets"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ constrained-element-sets: object
   :name: constrained-element-sets-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 constrained-element-set: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `constrained-element-set <#/definitions/constrained-element-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ctag-assignment" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ctag-assignment: object
   :name: ctag-assignment-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM l3-network (is composed of ctag-assignment)
-  FROM service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vlan-id-inner: integer
    id.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ctag-assignments" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ctag-assignments: object
   :name: ctag-assignments-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 ctag-assignment: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ctag-assignment <#/definitions/ctag-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ctag-pool" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ctag-pool: object
   :name: ctag-pool-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

A collection of C tags (vlan tags) grouped for a specific purpose.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO availability-zone (Many2Many)
-  FROM complex (is composed of ctag-pool)
-  FROM vpls-pe
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 target-pe: string
    The Target provider edge router

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 availability-zone-name: string
    Name of the availability zone

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ctag-pool-purpose: string
    Describes what the intended purpose of this pool is.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ctag-values: string
    Comma separated list of ctags

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ctag-pools" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ctag-pools: object
   :name: ctag-pools-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 ctag-pool: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ctag-pool <#/definitions/ctag-pool>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-customer" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ customer: object
   :name: customer-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

customer identifiers to provide linkage back to BSS information.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO service-subscription (comprises customer, Many2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 global-customer-id: string
    Global customer id used across ECOMP to uniquely identify customer.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subscriber-name: string
    Subscriber name, an alternate way to retrieve a customer.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subscriber-type: string
    Subscriber type, a way to provide VID with only the INFRA customers.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-subscriptions: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-subscription <#/definitions/service-subscription>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-customers" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ customers: object
   :name: customers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of customer identifiers to provide linkage back to BSS
information.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 customer: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `customer <#/definitions/customer>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-cvlan-tag-entry" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ cvlan-tag-entry: object
   :name: cvlan-tag-entry-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 cvlan-tag: integer
    See mis-na-virtualization-platform.yang

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-cvlan-tags" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ cvlan-tags: object
   :name: cvlan-tags-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 cvlan-tag-entry: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `cvlan-tag-entry <#/definitions/cvlan-tag-entry>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-dvs-switch" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ dvs-switch: object
   :name: dvs-switch-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

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.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO availability-zone (Many2Many)
-  FROM cloud-region (is composed of dvs-switch)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 switch-name: string
    DVS switch name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vcenter-url: string
    URL used to reach the vcenter

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-dvs-switches" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ dvs-switches: object
   :name: dvs-switches-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of digital virtual switch metadata used for vmWare VCEs and
GenericVnfs.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 dvs-switch: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `dvs-switch <#/definitions/dvs-switch>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-edge-prop-names" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ edge-prop-names: object
   :name: edge-prop-names-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Internal map to define the properties of an edge and interpret the map
EdgeRules

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 edgeLabel: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 direction: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 multiplicityRule: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 contains-other-v: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 delete-other-v: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 SVC-INFRA: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prevent-delete: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-edge-tag-query-request"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ edge-tag-query-request: object
   :name: edge-tag-query-request-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 edge-tag: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 result-detail: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 start-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 start-node-filter: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `start-node-filter <#/definitions/start-node-filter>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 include-node-filter: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `include-node-filter <#/definitions/include-node-filter>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 secondary-filter: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `secondary-filter <#/definitions/secondary-filter>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-edge-tag-query-result"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ edge-tag-query-result: object
   :name: edge-tag-query-result-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 tagged-inventory-item-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `tagged-inventory-item-list <#/definitions/tagged-inventory-item-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-element-choice-set"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ element-choice-set: object
   :name: element-choice-set-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This is how we would capture constraints defining allowed sets of
elements.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model-element (comprises element-choice-set, One2Many)
-  FROM constrained-element-set (is composed of element-choice-set)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 element-choice-set-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 element-choice-set-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cardinality: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-elements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-element <#/definitions/model-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-element-choice-sets"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ element-choice-sets: object
   :name: element-choice-sets-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 element-choice-set: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `element-choice-set <#/definitions/element-choice-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-entitlement" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ entitlement: object
   :name: entitlement-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Metadata for entitlement group.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM generic-vnf (is composed of entitlement)
-  FROM vce (is composed of entitlement)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 group-uuid: string
    Unique ID for the entitlement group the resource comes from, should
    be uuid.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-uuid: string
    Unique ID of an entitlement resource.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-entitlements" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ entitlements: object
   :name: entitlements-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Entitlements, keyed by group-uuid and resource-uuid, related to license
management

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 entitlement: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `entitlement <#/definitions/entitlement>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-ems" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-ems: object
   :name: esr-ems-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Persist EMS address information used by EMS driver.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO esr-system-info (comprises esr-ems, One2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 ems-id: string
    Unique ID of EMS.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 esr-system-info-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-ems-list" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-ems-list: object
   :name: esr-ems-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 esr-ems: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-ems <#/definitions/esr-ems>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-system-info" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-system-info: object
   :name: esr-system-info-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Persist common address information of external systems.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM esr-ems (is composed of esr-system-info)
-  FROM esr-vnfm (is composed of esr-system-info)
-  FROM esr-thirdparty-sdnc (is composed of esr-system-info)
-  FROM cloud-region (is composed of esr-system-info)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 esr-system-info-id: string
    Unique ID of esr system info.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 system-name: string
    name of external system.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 type: string
    type of external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vendor: string
    vendor of external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 version: string
    version of external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-url: string
    url used to access external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 user-name: string
    username used to access external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 password: string
    password used to access external systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 system-type: string
    it could be
    vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 protocol: string
    protocol of third party SDNC, for example netconf/snmp.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ssl-cacert: string
    ca file content if enabled ssl on auth-url.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ssl-insecure: boolean
    Whether to verify VIM's certificate.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ip-address: string
    service IP of ftp server.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 port: string
    service port of ftp server.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cloud-domain: string
    domain info for authentication.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 default-tenant: string
    default tenant of VIM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 passive: boolean
    ftp passive mode or not.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 remote-path: string
    resource or performance data file path.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 system-status: string
    the status of external system.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-system-info-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-system-info-list: object
   :name: esr-system-info-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of persistent block-level external system auth info.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 esr-system-info: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-thirdparty-sdnc"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-thirdparty-sdnc: object
   :name: esr-thirdparty-sdnc-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Persist SDNC address information used by ONAP SDNC.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
-  TO pnf (One2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 thirdparty-sdnc-id: string
    Unique ID of SDNC.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 location: string
    used for DC type to indicate the location of SDNC, such as Core or
    Edge.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 product-name: string
    password used to access SDNC server.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 esr-system-info-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-thirdparty-sdnc-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-thirdparty-sdnc-list: object
   :name: esr-thirdparty-sdnc-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 esr-thirdparty-sdnc: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-thirdparty-sdnc <#/definitions/esr-thirdparty-sdnc>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-vnfm" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-vnfm: object
   :name: esr-vnfm-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Persist VNFM address information used by VF-C.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO esr-system-info (comprises esr-vnfm, One2One)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnfm-id: string
    Unique ID of VNFM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vim-id: string
    indecate the VIM to deploy VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 certificate-url: string
    certificate url of VNFM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 esr-system-info-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-system-info <#/definitions/esr-system-info>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-esr-vnfm-list" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ esr-vnfm-list: object
   :name: esr-vnfm-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 esr-vnfm: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-vnfm <#/definitions/esr-vnfm>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-external-system" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ external-system: object
   :name: external-system-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Namespace for external system.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 esr-ems-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-ems <#/definitions/esr-ems>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 esr-vnfm-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-vnfm <#/definitions/esr-vnfm>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 esr-thirdparty-sdnc-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `esr-thirdparty-sdnc <#/definitions/esr-thirdparty-sdnc>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-extra-properties" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ extra-properties: object
   :name: extra-properties-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Extra properties for inventory item for response list

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 extra-property: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `extra-property <#/definitions/extra-property>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-extra-property" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ extra-property: object
   :name: extra-property-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-flavor" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ flavor: object
   :name: flavor-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack flavor.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM cloud-region (is composed of flavor)
-  FROM vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 flavor-id: string
    Flavor id, expected to be unique across cloud-region.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-name: string
    Flavor name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-vcpus: integer
    Number of CPUs

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-ram: integer
    Amount of memory

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-disk: integer
    Disk space

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-ephemeral: integer
    Amount of ephemeral disk space

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-swap: string
    amount of swap space allocation

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-is-public: boolean
    whether flavor is available to all users or private to the tenant it
    was created in.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 flavor-disabled: boolean
    Boolean as to whether this flavor is no longer enabled

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-flavors" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ flavors: object
   :name: flavors-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack flavors.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 flavor: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `flavor <#/definitions/flavor>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-generic-vnf" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ generic-vnf: object
   :name: generic-vnf-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

General purpose VNF

.. rubric:: Related Nodes
   :name: related-nodes

-  TO license-key-resource (Many2Many)
-  TO l-interface (comprises generic-vnf, Many2Many)
-  TO availability-zone (Many2Many)
-  TO lag-interface (comprises generic-vnf, Many2Many)
-  TO l3-network (Many2Many)
-  TO pserver (Many2Many)
-  TO vnf-image (Many2One)
-  TO vserver (One2Many)
-  TO service-instance (Many2Many)
-  TO site-pair-set (Many2Many)
-  TO network-profile (Many2Many)
-  TO pnf (Many2Many)
-  TO ipsec-configuration (Many2One)
-  TO configuration (One2Many)
-  TO vf-module (comprises generic-vnf, One2Many)
-  TO volume-group (One2Many)
-  TO vnfc (One2Many)
-  TO instance-group (Many2Many)
-  TO entitlement (comprises generic-vnf, One2Many)
-  TO license (comprises generic-vnf, One2Many)
-  TO complex (Many2Many)
-  TO ctag-pool (Many2Many)
-  FROM line-of-business
-  FROM platform
-  FROM virtual-data-center
-  FROM logical-link
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-id: string
    Unique id of VNF. This is unique across the graph.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name: string
    Name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name2: string
    Alternate name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-type: string
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-id: string
    Unique identifier of service, does not necessarily map to ASDC
    service models. SOON TO BE DEPRECATED

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 regional-resource-zone: string
    Regional way of organizing pservers, source of truth should define
    values

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this resource by Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational. Valid
    values are in-service-path and out-of-service-path.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 license-key: string
    OBSOLETE - do not use

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equipment-role: string
    Client should send valid enumerated value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, used by MSO.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance, managed by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mso-catalog-key: string
    Corresponds to the SDN-C catalog id used to configure this VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-option: string
    identifier of managed by ATT or customer

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-address: string
    Address tail-f uses to configure generic-vnf, also used for
    troubleshooting and is IP used for traps generated by generic-vnf.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-loopback0-address: string
    v4 Loopback0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nm-lan-v6-address: string
    v6 Loopback address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-v6-address: string
    v6 management address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vcpu: integer
    number of vcpus ordered for this instance of VNF, used for VNFs with
    no vservers/flavors, to be used only by uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vcpu-units: string
    units associated with vcpu, used for VNFs with no vservers/flavors,
    to be used only by uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vmemory: integer
    number of GB of memory ordered for this instance of VNF, used for
    VNFs with no vservers/flavors, to be used only by uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vmemory-units: string
    units associated with vmemory, used for VNFs with no
    vservers/flavors, to be used only by uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vdisk: integer
    number of vdisks ordered for this instance of VNF, used for VNFs
    with no vservers/flavors, to be used only uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vdisk-units: string
    units associated with vdisk, used for VNFs with no vservers/flavors,
    to be used only by uCPE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-closed-loop-disabled: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 summary-status: string
    details regarding the generic-vnf operation, PLEASE DISCONTINUE USE
    OF THIS FIELD.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 encrypted-access-flag: boolean
    indicates whether generic-vnf access uses SSH

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 entitlement-assignment-group-uuid: string
    UUID of the Entitlement group used for licensing VNFs, OBSOLETE -
    See child relationships.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 entitlement-resource-uuid: string
    UUID of the specific entitlement resource. OBSOLETE - See child
    relationships.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 license-assignment-group-uuid: string
    UUID of the license assignment group. OBSOLETE - See child
    relationships.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 license-key-uuid: string
    UUID of the actual license resource. OBSOLETE - See child
    relationships.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-customization-id: string
    captures the id of all the configuration used to customize the
    resource for the service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 as-number: string
    as-number of the VNF

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 regional-resource-subzone: string
    represents sub zone of the rr plane

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nf-type: string
    Generic description of the type of NF

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nf-function: string
    English description of Network function that the specific VNF
    deployment is providing

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nf-role: string
    role in the network that this model will be providing

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nf-naming-code: string
    string assigned to this model used for naming purposes

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    Path to the controller object.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-gateway-address: string
    Gateway address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-gateway-address-prefix-length: integer
    Prefix length for oam-address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Temporary location for S-TAG to get to VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nm-profile-name: string
    Network Management profile of this VNF

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lag-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vf-modules: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vf-module <#/definitions/vf-module>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 licenses: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `license <#/definitions/license>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 entitlements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `entitlement <#/definitions/entitlement>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-generic-vnfs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ generic-vnfs: object
   :name: generic-vnfs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of VNFs

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 generic-vnf: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `generic-vnf <#/definitions/generic-vnf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-group-assignment" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ group-assignment: object
   :name: group-assignment-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack group-assignment used to store exclusivity groups (EG).

.. rubric:: Related Nodes
   :name: related-nodes

-  TO tenant (Many2Many)
-  TO pserver (One2Many)
-  FROM cloud-region (is composed of group-assignment)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 group-id: string
    Group id, expected to be unique across cloud-region.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 group-type: string
    Group type - the type of group this instance refers to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 group-name: string
    Group name - name assigned to the group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 group-description: string
    Group description - description of the group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-group-assignments"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ group-assignments: object
   :name: group-assignments-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack group assignments

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 group-assignment: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `group-assignment <#/definitions/group-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-host-route" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ host-route: object
   :name: host-route-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM subnet (is composed of host-route)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 host-route-id: string
    host-route id

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 route-prefix: string
    subnet prefix

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 next-hop: string
    Could be ip-address, hostname, or service-instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 next-hop-type: string
    Should be ip-address, hostname, or service-instance to match
    next-hop

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-host-routes" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ host-routes: object
   :name: host-routes-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 host-route: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `host-route <#/definitions/host-route>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-image" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ image: object
   :name: image-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack image.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO metadatum (comprises image, Many2Many)
-  FROM cloud-region (is composed of image)
-  FROM vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 image-id: string
    Image id, expected to be unique across cloud region

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 image-name: string
    Image name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 image-architecture: string
    Operating system architecture.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 image-os-distro: string
    The common name of the operating system distribution in lowercase

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 image-os-version: string
    The operating system version as specified by the distributor.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application: string
    The application that the image instantiates.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-vendor: string
    The vendor of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-version: string
    The version of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 image-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 metadata: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadatum <#/definitions/metadatum>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-images" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ images: object
   :name: images-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collectio of Openstack images.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 image: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `image <#/definitions/image>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-include-node-filter"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ include-node-filter: object
   :name: include-node-filter-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 include-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-instance-filter" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ instance-filter: object
   :name: instance-filter-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

InstanceFilter for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-instance-filters" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ instance-filters: object
   :name: instance-filters-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

InstanceFilters for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 instance-filter: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `instance-filter <#/definitions/instance-filter>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-instance-group" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ instance-group: object
   :name: instance-group-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

General mechanism for grouping instances

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model (Many2Many)
-  FROM l-interface
-  FROM vnfc
-  FROM l3-interface-ipv4-address-list
-  FROM l3-interface-ipv6-address-list
-  FROM l3-network
-  FROM pnf
-  FROM allotted-resource
-  FROM generic-vnf
-  FROM service-instance
-  FROM vip-ipv4-address-list
-  FROM vip-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 instance-group-role: string
    role of the instance group.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    ASDC model version uid for this resource model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 id: string
    Instance Group ID, UUID assigned to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 description: string
    Descriptive text to help identify the usage of this instance-group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 type: string
    Only valid value today is lower case ha for high availability

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 sub-type: string
    Valid values for ha type are [geo-activeactive, geo-activestandby,
    local-activeactive, local-activestandby]

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-instance-groups" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ instance-groups: object
   :name: instance-groups-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack route table references

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 instance-group: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `instance-group <#/definitions/instance-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-inventory" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ inventory: object
   :name: inventory-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 search: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `search <#/definitions/search>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 actions: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `actions <#/definitions/actions>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 cloud-infrastructure: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `cloud-infrastructure <#/definitions/cloud-infrastructure>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 external-system: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `external-system <#/definitions/external-system>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 business: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `business <#/definitions/business>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 service-design-and-creation: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `service-design-and-creation <#/definitions/service-design-and-creation>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 network: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `network <#/definitions/network>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 aai-internal: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `aai-internal <#/definitions/aai-internal>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 nodes: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     ` <#/definitions/>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-inventory-item" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ inventory-item: object
   :name: inventory-item-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 inventory-item-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 inventory-item-link: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 inventory-item-data: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `inventory-item-data <#/definitions/inventory-item-data>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 tagged-inventory-item-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `tagged-inventory-item-list <#/definitions/tagged-inventory-item-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-inventory-item-data"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ inventory-item-data: object
   :name: inventory-item-data-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-inventory-response-item"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ inventory-response-item: object
   :name: inventory-response-item-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Inventory item for response list

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 extra-properties: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `extra-properties <#/definitions/extra-properties>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 inventory-response-items: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `inventory-response-items <#/definitions/inventory-response-items>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-inventory-response-items"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ inventory-response-items: object
   :name: inventory-response-items-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Container for inventory items in response list

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 inventory-response-item: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `inventory-response-item <#/definitions/inventory-response-item>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ipsec-configuration"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ipsec-configuration: object
   :name: ipsec-configuration-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

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

.. rubric:: Related Nodes
   :name: related-nodes

-  TO vig-server (comprises ipsec-configuration, One2Many)
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 ipsec-configuration-id: string
    UUID of this configuration

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 requested-vig-address-type: string
    Indicate the type of VIG server like AVPN, INTERNET, BOTH

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 requested-encryption-strength: string
    Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc,
    aes-265-cbc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 requested-dmz-type: string
    ATT can offer a shared DMZ or a DMZ specific to a customer

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 shared-dmz-network-address: string
    Network address of shared DMZ

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 requested-customer-name: string
    If the DMZ is a custom DMZ, this field will indicate the customer
    information

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ike-version: string
    can be 1 or 2

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-authentication: string
    Contains values like md5, sha1, sha256, sha384

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-encryption: string
    Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc,
    aes-265-cbc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-dh-group: string
    Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-am-group-id: string
    Group name defined in VIG for clients using aggressive mode

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-am-password: string
    pre-shared key for the above group name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ikev1-sa-lifetime: string
    Lifetime for IKEv1 SA

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipsec-authentication: string
    md5, sha1, sha256, sha384

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipsec-encryption: string
    3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipsec-sa-lifetime: string
    Life time for IPSec SA

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipsec-pfs: string
    enable PFS or not

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 xauth-userid: string
    user ID for xAuth, sm-user,ucpeHostName,nmteHostName

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 xauth-user-password: string
    Encrypted using the Juniper $9$ algorithm

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dpd-interval: string
    The time between DPD probe

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dpd-frequency: string
    Maximum number of DPD before claiming the tunnel is down

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vig-servers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vig-server <#/definitions/vig-server>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-ipsec-configurations"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ ipsec-configurations: object
   :name: ipsec-configurations-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 ipsec-configuration: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ipsec-configuration <#/definitions/ipsec-configuration>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-key-data" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ key-data: object
   :name: key-data-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 key-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 key-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l-interface" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l-interface: object
   :name: l-interface-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Logical interfaces, e.g., a vnic.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many)
-  TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many)
-  TO l-interface (comprises l-interface, One2Many)
-  TO logical-link (Many2Many)
-  TO vlan (comprises l-interface, Many2Many)
-  TO sriov-vf (comprises l-interface, One2One)
-  FROM generic-vnf (is composed of l-interface)
-  FROM lag-interface (is composed of l-interface)
-  FROM newvce (is composed of l-interface)
-  FROM p-interface (is composed of l-interface)
-  FROM vserver (is composed of l-interface)
-  FROM allotted-resource
-  FROM l-interface (is composed of l-interface)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 interface-name: string
    Name given to the interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-role: string
    E.g., CUSTOMER, UPLINK, etc.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 v6-wan-link-ip: string
    Questionably placed - v6 ip addr of this interface (is in
    vr-lan-interface from Mary B.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-id: string
    ID of interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 macaddr: string
    MAC address for the interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-name: string
    Name of the network

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-option: string
    Whether A&AI should be managing this interface of not. Could have
    value like CUSTOMER

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-description: string
    Human friendly text regarding this interface.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-port-mirrored: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Prov Status of the logical interface. Valid values
    [PREPROV/NVTPROV/PROV].

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-ip-unnumbered: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 allowed-address-pairs: string
    Freeform field for storing an ip address, list of ip addresses or a
    subnet block.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlans: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vlan <#/definitions/vlan>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 sriov-vfs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv4-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv6-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l-interfaces" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l-interfaces: object
   :name: l-interfaces-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of logical interfaces.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 l-interface: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l3-interface-ipv4-address-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l3-interface-ipv4-address-list: object
   :name: l3-interface-ipv4-address-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

IPv4 Address Range

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO l3-network (Many2Many)
-  TO subnet (Many2Many)
-  TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
-  FROM l-interface (is composed of l3-interface-ipv4-address-list)
-  FROM vlan (is composed of l3-interface-ipv4-address-list)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 l3-interface-ipv4-address: string
    IP address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 l3-interface-ipv4-prefix-length: integer
    Prefix length, 32 for single address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-inner: integer
    Inner VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Outer VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-floating: boolean
    Indicator of fixed or floating address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of the interface that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-subnet-id: string
    Neutron id of subnet that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l3-interface-ipv6-address-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l3-interface-ipv6-address-list: object
   :name: l3-interface-ipv6-address-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

IPv6 Address Range

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO l3-network (Many2Many)
-  TO subnet (Many2Many)
-  TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
-  FROM l-interface (is composed of l3-interface-ipv6-address-list)
-  FROM vlan (is composed of l3-interface-ipv6-address-list)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 l3-interface-ipv6-address: string
    IP address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 l3-interface-ipv6-prefix-length: integer
    Prefix length, 128 for single address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-inner: integer
    Inner VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Outer VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-floating: boolean
    Indicator of fixed or floating address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of the interface that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-subnet-id: string
    Neutron id of subnet that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l3-network" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l3-network: object
   :name: l3-network-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Generic network definition

.. rubric:: Related Nodes
   :name: related-nodes

-  TO vpn-binding (Many2Many)
-  TO instance-group (Many2Many)
-  TO subnet (comprises l3-network, Many2Many)
-  TO service-instance (Many2Many)
-  TO ctag-assignment (comprises l3-network, Many2Many)
-  TO network-policy (Many2Many)
-  TO segmentation-assignment (comprises l3-network, One2Many)
-  TO route-table-reference (Many2Many)
-  FROM cloud-region
-  FROM complex
-  FROM generic-vnf
-  FROM l3-interface-ipv4-address-list
-  FROM l3-interface-ipv6-address-list
-  FROM tenant
-  FROM vf-module
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 network-id: string
    Network ID, should be uuid. Unique across A&AI.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-name: string
    Name of the network, governed by some naming convention..

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-type: string
    Type of the network - who defines these values?

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-role: string
    Role the network plans - who defines these values?

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-technology: string
    Network technology - who defines these values?

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of this Interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-bound-to-vpn: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-id: string
    Unique identifier of service from ASDC. Does not strictly map to
    ASDC services. SOON TO BE DEPRECATED

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-role-instance: integer
    network role instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance, managed by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mso-catalog-key: string
    Corresponds to the SDN-C catalog id used to configure this VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 contrail-network-fqdn: string
    Contrail FQDN for the network

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-customization-id: string
    captures the id of all the configuration used to customize the
    resource for the service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 physical-network-name: string
    Name associated with the physical network.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-provider-network: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-shared-network: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-external-network: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    Path to the controller object.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subnets: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `subnet <#/definitions/subnet>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 ctag-assignments: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ctag-assignment <#/definitions/ctag-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 segmentation-assignments: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `segmentation-assignment <#/definitions/segmentation-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-l3-networks" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ l3-networks: object
   :name: l3-networks-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 l3-network: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l3-network <#/definitions/l3-network>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-lag-interface" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ lag-interface: object
   :name: lag-interface-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Link aggregate interface

.. rubric:: Related Nodes
   :name: related-nodes

-  TO logical-link (Many2Many)
-  TO lag-link (Many2Many)
-  TO p-interface (Many2Many)
-  TO l-interface (comprises lag-interface, Many2Many)
-  FROM generic-vnf (is composed of lag-interface)
-  FROM pserver (is composed of lag-interface)
-  FROM pnf (is composed of lag-interface)
-  FROM vpls-pe (is composed of lag-interface)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 interface-name: string
    Name that identifies the link aggregate interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-description: string
    Human friendly text regarding this interface.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-value: string
    Captures the numeric part of the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-units: string
    Captures the units corresponding to the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-id: string
    ID of interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-role: string
    Role assigned to this Interface, should use values as defined in
    ECOMP Yang models.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this resource by Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-lag-interfaces" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ lag-interfaces: object
   :name: lag-interfaces-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of link aggregate interfaces.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 lag-interface: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-lag-link" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ lag-link: object
   :name: lag-link-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

LAG links can connect lag-interfaces

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM lag-interface
-  FROM logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 link-name: string
    Alphabetical concatenation of lag-interface names

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-lag-links" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ lag-links: object
   :name: lag-links-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of link aggregation connections

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 lag-link: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-link <#/definitions/lag-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-license" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ license: object
   :name: license-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Metadata for license group.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM generic-vnf (is composed of license)
-  FROM vce (is composed of license)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 group-uuid: string
    Unique ID for the license group the resource belongs to, should be
    uuid.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-uuid: string
    Unique ID of a license resource.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-licenses" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ licenses: object
   :name: licenses-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Licenses to be allocated across resources, keyed by group-uuid and
resource-uuid, related to license management

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 license: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `license <#/definitions/license>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-line-of-business" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ line-of-business: object
   :name: line-of-business-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

describes a line-of-business

.. rubric:: Related Nodes
   :name: related-nodes

-  TO generic-vnf (Many2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 line-of-business-name: string
    Name of the line-of-business (product)

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-lines-of-business"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ lines-of-business: object
   :name: lines-of-business-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of lines-of-business

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 line-of-business: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `line-of-business <#/definitions/line-of-business>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-logical-link" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ logical-link: object
   :name: logical-link-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Logical links generally connect l-interfaces but are used to express
logical connectivity between two points

.. rubric:: Related Nodes
   :name: related-nodes

-  TO lag-link (Many2Many)
-  TO pnf (Many2Many)
-  TO logical-link (One2Many)
-  TO generic-vnf (Many2Many)
-  TO pserver (Many2Many)
-  TO cloud-region (Many2Many)
-  TO vpn-binding (Many2Many)
-  FROM configuration
-  FROM l-interface
-  FROM lag-interface
-  FROM p-interface
-  FROM service-instance
-  FROM virtual-data-center
-  FROM vlan
-  FROM logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 link-name: string
    e.g., evc-name, or
    vnf-nameA\_interface-nameA\_vnf-nameZ\_interface-nameZ

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 link-type: string
    Type of logical link, e.g., evc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-value: string
    Captures the numeric part of the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-units: string
    Captures the units corresponding to the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ip-version: string
    v4, v6, or ds for dual stack

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 routing-protocol: string
    For example, static or BGP

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indication of operational status of the logical link.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this VNF by BAU Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 link-role: string
    Indication of the network use of the logical link.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 link-name2: string
    Alias or alternate name (CLCI or D1 name).

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 link-id: string
    UUID of the logical-link, SDNC generates this.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 circuit-id: string
    Circuit id

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 purpose: string
    Reason for this entity, role it is playing

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-logical-links" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ logical-links: object
   :name: logical-links-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of logical connections

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 logical-link: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `logical-link <#/definitions/logical-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-metadata" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ metadata: object
   :name: metadata-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of metadatum (key/value pairs)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 metadatum: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadatum <#/definitions/metadatum>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-metadatum" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ metadatum: object
   :name: metadatum-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Key/value pairs

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM configuration (is composed of metadatum)
-  FROM image (is composed of metadatum)
-  FROM model-ver (is composed of metadatum)
-  FROM service-instance (is composed of metadatum)
-  FROM connector (is composed of metadatum)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 metaname: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 metaval: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model: object
   :name: model-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Subgraph definition provided by ASDC to describe an inventory asset and
its connections related to ASDC models, independent of version

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model-ver (comprises model, One2Many)
-  FROM named-query
-  FROM named-query-element
-  FROM instance-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-invariant-id: string
    Unique identifier corresponding to the main definition of a model in
    ASDC

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-type: string
    Type of the model, e.g., service, resource, widget, etc.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-vers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-ver <#/definitions/model-ver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-and-named-query-search"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-and-named-query-search: object
   :name: model-and-named-query-search-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

ModelAndNamedQuerySearch holds query-parameters and instance-properties
for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 top-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 secondary-filter-cut-point: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 query-parameters: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `query-parameters <#/definitions/query-parameters>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 instance-filters: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `instance-filters <#/definitions/instance-filters>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 secondary-filts: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `secondary-filts <#/definitions/secondary-filts>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-constraint" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-constraint: object
   :name: model-constraint-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This is how we would capture constraints defining allowed sets of
elements.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO constrained-element-set (comprises model-constraint, One2Many)
-  FROM model-element (is composed of model-constraint)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-constraint-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 constrained-element-set-uuid-to-replace: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 constrained-element-sets: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `constrained-element-set <#/definitions/constrained-element-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-constraints"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-constraints: object
   :name: model-constraints-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 model-constraint: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-constraint <#/definitions/model-constraint>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-element" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-element: object
   :name: model-element-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Defines how other models combine to make up a higher-level model.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model-ver (Many2One)
-  TO model-element (comprises model-element, One2Many)
-  TO model-constraint (comprises model-element, One2Many)
-  TO constrained-element-set (comprises model-element, One2Many)
-  FROM model-ver (is composed of model-element)
-  FROM element-choice-set (is composed of model-element)
-  FROM model-element (is composed of model-element)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-element-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 new-data-del-flag: string
    Indicates whether this element was created as part of instantiation
    from this model

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cardinality: string
    How many of this type of element are required/allowed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 linkage-points: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-elements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-element <#/definitions/model-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 model-constraints: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-constraint <#/definitions/model-constraint>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-elements" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-elements: object
   :name: model-elements-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 model-element: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-element <#/definitions/model-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-ver" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-ver: object
   :name: model-ver-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Subgraph definition provided by ASDC to describe a specific version of
an inventory asset and its connections related to ASDC models

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model-element (comprises model-ver, One2Many)
-  TO metadatum (comprises model-ver, One2Many)
-  FROM model (is composed of model-ver)
-  FROM model-element

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-version-id: string
    Unique identifier corresponding to one version of a model in ASDC

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-name: string
    Name of the model, which can change from version to version.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version: string
    Version

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-description: string
    Description

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-elements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-element <#/definitions/model-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 metadata: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadatum <#/definitions/metadatum>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-model-vers" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ model-vers: object
   :name: model-vers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 model-ver: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-ver <#/definitions/model-ver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-models" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ models: object
   :name: models-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of subgraph definitions provided by ASDC to describe the
inventory assets and their connections related to ASDC models

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model <#/definitions/model>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-multicast-configuration"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ multicast-configuration: object
   :name: multicast-configuration-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM vlan

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 multicast-configuration-id: string
    Unique id of multicast configuration.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 multicast-protocol: string
    protocol of multicast configuration

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 rp-type: string
    rp type of multicast configuration

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-multicast-configurations"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ multicast-configurations: object
   :name: multicast-configurations-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

multicast configuration of generic-vnf ip-address

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 multicast-configuration: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `multicast-configuration <#/definitions/multicast-configuration>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-named-queries" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ named-queries: object
   :name: named-queries-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 named-query: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query <#/definitions/named-query>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-named-query" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ named-query: object
   :name: named-query-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

TBD

.. rubric:: Related Nodes
   :name: related-nodes

-  TO model (One2Many)
-  TO named-query-element (comprises named-query, One2One)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 named-query-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 named-query-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 named-query-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 required-input-param: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 description: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 named-query-elements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query-element <#/definitions/named-query-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-named-query-element"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ named-query-element: object
   :name: named-query-element-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

TBD

.. rubric:: Related Nodes
   :name: related-nodes

-  TO named-query-element (comprises named-query-element, Many2Many)
-  TO model (Many2One)
-  TO property-constraint (comprises named-query-element, One2Many)
-  TO related-lookup (comprises named-query-element, One2Many)
-  FROM named-query (is composed of named-query-element)
-  FROM named-query-element (is composed of named-query-element)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 named-query-element-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-collect-list: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-limit-desc: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 do-not-output: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 named-query-elements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query-element <#/definitions/named-query-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 related-lookups: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `related-lookup <#/definitions/related-lookup>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 property-constraints: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `property-constraint <#/definitions/property-constraint>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-named-query-elements"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ named-query-elements: object
   :name: named-query-elements-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 named-query-element: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query-element <#/definitions/named-query-element>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-network" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ network: object
   :name: network-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Namespace for network inventory resources.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 logical-links: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `logical-link <#/definitions/logical-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 site-pair-sets: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `site-pair-set <#/definitions/site-pair-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vpn-bindings: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vpn-binding <#/definitions/vpn-binding>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vpls-pes: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vpls-pe <#/definitions/vpls-pe>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 multicast-configurations: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `multicast-configuration <#/definitions/multicast-configuration>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vce <#/definitions/vce>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 vnfcs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vnfc <#/definitions/vnfc>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-networks: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l3-network <#/definitions/l3-network>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 network-policies: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `network-policy <#/definitions/network-policy>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 generic-vnfs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `generic-vnf <#/definitions/generic-vnf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lag-links: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-link <#/definitions/lag-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 newvces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `newvce <#/definitions/newvce>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 pnfs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `pnf <#/definitions/pnf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 physical-links: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `physical-link <#/definitions/physical-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 ipsec-configurations: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `ipsec-configuration <#/definitions/ipsec-configuration>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 route-table-references: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `route-table-reference <#/definitions/route-table-reference>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 instance-groups: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `instance-group <#/definitions/instance-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 zones: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `zone <#/definitions/zone>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-network-policies" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ network-policies: object
   :name: network-policies-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 network-policy: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `network-policy <#/definitions/network-policy>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-network-policy" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ network-policy: object
   :name: network-policy-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM l3-network
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 network-policy-id: string
    UUID representing unique key to this instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-policy-fqdn: string
    Contrail FQDN for the policy

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    ID for the openStack Heat instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-network-profile" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ network-profile: object
   :name: network-profile-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Network profile populated by SDN-GP for SNMP

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 nm-profile-name: string
    Unique name of network profile.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 community-string: string
    Encrypted SNMP community string

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-network-profiles" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ network-profiles: object
   :name: network-profiles-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of network profiles

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 network-profile: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `network-profile <#/definitions/network-profile>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-newvce" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ newvce: object
   :name: newvce-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This object fills in the gaps from vce that were incorporated into
generic-vnf. This object will be retired with vce.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO l-interface (comprises newvce, Many2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-id2: string
    Unique id of VNF, can't use same attribute name right now until we
    promote this new object

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name: string
    Name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name2: string
    Alternate name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-type: string
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this VNF by BAU Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 license-key: string
    OBSOLETE - do not use

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-address: string
    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).

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equipment-role: string
    Client should send valid enumerated value.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-loopback0-address: string
    v4 Loopback0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by MSO.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance, managed by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mso-catalog-key: string
    Corresponds to the SDN-C catalog id used to configure this VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-newvces" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ newvces: object
   :name: newvces-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This object fills in the gaps from vce that were incorporated into
generic-vnf. This object will be retired with vce.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 newvce: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `newvce <#/definitions/newvce>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-notification-event"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ notification-event: object
   :name: notification-event-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 cambria.partition: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 notification-event-header: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `notification-event-header <#/definitions/notification-event-header>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-notification-event-header"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ notification-event-header: object
   :name: notification-event-header-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 id: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 timestamp: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 source-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 domain: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 sequence-number: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 severity: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 event-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 action: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 entity-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 top-entity-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 entity-link: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 status: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-notify" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ notify: object
   :name: notify-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 event-id: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 event-trigger: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 key-data: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `key-data <#/definitions/key-data>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-oam-network" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ oam-network: object
   :name: oam-network-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

OAM network, to be deprecated shortly. Do not use for new purposes.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2Many)
-  TO service-capability (Many2Many)
-  FROM cloud-region (is composed of oam-network)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 network-uuid: string
    UUID of the network. Unique across a cloud-region

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-name: string
    Name of the network.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cvlan-tag: integer
    cvlan-id

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-gateway-address: string
    Used for VNF firewall rule so customer cannot send customer traffic
    over this oam network

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-gateway-address-prefix-length: integer
    Used for VNF firewall rule so customer cannot send customer traffic
    over this oam network

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-oam-networks" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ oam-networks: object
   :name: oam-networks-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of OAM networks, to be deprecated shortly. Do not use for new
purposes.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 oam-network: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `oam-network <#/definitions/oam-network>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-overloaded-model" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ overloaded-model: object
   :name: overloaded-model-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Allows for legacy POST of old-style and new-style models

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 model-invariant-id: string
    Unique identifier corresponding to the main definition of a model in
    ASDC

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-name-version-id: string
    Unique identifier corresponding to one version of a model in ASDC

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-type: string
    Type of the model, e.g., service, resource, widget, etc.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-name: string
    Name of the model, which can change from version to version.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-id: string
    Invariant unique ID which does not change from version to version

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version: string
    Version

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-description: string
    Description

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-vers: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model-vers <#/definitions/model-vers>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship-list <#/definitions/relationship-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-owning-entities" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ owning-entities: object
   :name: owning-entities-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of owning-entities

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 owning-entity: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `owning-entity <#/definitions/owning-entity>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-owning-entity" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ owning-entity: object
   :name: owning-entity-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

describes an owning-entity

.. rubric:: Related Nodes
   :name: related-nodes

-  TO service-instance (One2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 owning-entity-id: string
    UUID of an owning entity

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 owning-entity-name: string
    Owning entity name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-p-interface" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ p-interface: object
   :name: p-interface-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Physical interface (e.g., nic)

.. rubric:: Related Nodes
   :name: related-nodes

-  TO l-interface (comprises p-interface, Many2Many)
-  TO physical-link (Many2Many)
-  TO logical-link (Many2One)
-  TO sriov-pf (comprises p-interface, One2One)
-  FROM lag-interface
-  FROM pserver (is composed of p-interface)
-  FROM pnf (is composed of p-interface)
-  FROM vpls-pe (is composed of p-interface)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 interface-name: string
    Name that identifies the physical interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-value: string
    Captures the numeric part of the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-units: string
    Captures the units corresponding to the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 port-description: string
    Nature of the services and connectivity on this port.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equipment-identifier: string
    CLEI or other specification for p-interface hardware.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-role: string
    Role specification for p-interface hardware.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-type: string
    Indicates the physical properties of the interface.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this resource by Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mac-addresss: string
    MAC Address of the p-interface.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 inv-status: string
    inventory status

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 sriov-pfs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `sriov-pf <#/definitions/sriov-pf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-p-interfaces" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ p-interfaces: object
   :name: p-interfaces-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of physical interfaces.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 p-interface: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `p-interface <#/definitions/p-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-physical-link" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ physical-link: object
   :name: physical-link-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of physical connections, typically between p-interfaces

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM p-interface

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 link-name: string
    e.g., hostnameA\_p-connection\_nameA\_hostnameZ+p\_connection-nameZ

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-value: string
    Captures the numeric part of the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-units: string
    Captures the units corresponding to the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 circuit-id: string
    Circuit it

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dual-mode: string
    Dual access mode (e.g., primary, secondary

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-option: string
    To provide information on who manages this circuit. A&AI or 3rd
    party transport provider

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-provider-name: string
    Name of the service Provider on this link.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-provider-bandwidth-up-value: integer
    Upstream Bandwidth value agreed with the service provider

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-provider-bandwidth-up-units: string
    Units for the upstream BW value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-provider-bandwidth-down-value: integer
    Downstream Bandwidth value agreed with the service provider

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-provider-bandwidth-down-units: string
    Units for downstream BW value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-physical-links" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ physical-links: object
   :name: physical-links-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of physical connections, typically between p-interfaces

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 physical-link: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `physical-link <#/definitions/physical-link>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-platform" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ platform: object
   :name: platform-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

describes a platform

.. rubric:: Related Nodes
   :name: related-nodes

-  TO generic-vnf (Many2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 platform-name: string
    Name of the platform

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-platforms" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ platforms: object
   :name: platforms-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of platforms

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 platform: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `platform <#/definitions/platform>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-pnf" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ pnf: object
   :name: pnf-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

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.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO p-interface (comprises pnf, Many2Many)
-  TO lag-interface (comprises pnf, One2Many)
-  TO complex (Many2One)
-  TO instance-group (Many2Many)
-  TO zone (Many2One)
-  FROM esr-thirdparty-sdnc
-  FROM generic-vnf
-  FROM logical-link
-  FROM service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 pnf-name: string
    unique name of Physical Network Function.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pnf-name2: string
    name of Physical Network Function.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pnf-name2-source: string
    source of name2

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pnf-id: string
    id of pnf

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-type: string
    Equipment type. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-vendor: string
    Equipment vendor. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-model: string
    Equipment model. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-option: string
    identifier of managed by ATT or customer

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-oam: string
    ipv4-oam-address with new naming convention for IP addresses

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 sw-version: string
    sw-version is the version of SW for the hosted application on the
    PNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 frame-id: string
    ID of the physical frame (relay rack) where pnf is installed.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 serial-number: string
    Serial number of the device

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-loopback-0: string
    IPV4 Loopback 0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-loopback-0: string
    IPV6 Loopback 0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-aim: string
    IPV4 AIM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-aim: string
    IPV6 AIM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-oam: string
    IPV6 OAM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 inv-status: string
    CANOPI's inventory status. Only set with values exactly as defined
    by CANOPI.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Prov Status of this device (not under canopi control) Valid values
    [PREPROV/NVTPROV/PROV]

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nf-role: string
    Nf Role is the role performed by this instance in the network.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 p-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `p-interface <#/definitions/p-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lag-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-pnfs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ pnfs: object
   :name: pnfs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of Physical Network Functions.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 pnf: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `pnf <#/definitions/pnf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-port-group" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ port-group: object
   :name: port-group-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Used to capture the network interfaces of this VCE

.. rubric:: Related Nodes
   :name: related-nodes

-  TO cvlan-tag (comprises port-group, Many2Many)
-  FROM vce (is composed of port-group)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 interface-id: string
    Unique ID of the interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of this Interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-name: string
    Neutron network name of this Interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 interface-role: string
    Role assigned to this Interface, should use values as defined in
    ECOMP Yang models.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 port-group-id: string
    Unique ID for port group in vmware

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 port-group-name: string
    Likely to duplicate value of neutron network name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 switch-name: string
    DVS or standard switch name (should be non-null for port groups
    associated with DVS)

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance, managed by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mso-catalog-key: string
    Corresponds to the SDN-C catalog id used to configure this VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cvlan-tags: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `cvlan-tag-entry <#/definitions/cvlan-tag-entry>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-port-groups" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ port-groups: object
   :name: port-groups-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 port-group: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `port-group <#/definitions/port-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-project" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ project: object
   :name: project-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

describes the project

.. rubric:: Related Nodes
   :name: related-nodes

-  TO service-instance (One2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 project-name: string
    Name of the project deploying a service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-projects" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ projects: object
   :name: projects-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of projects

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 project: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `project <#/definitions/project>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-properties" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ properties: object
   :name: properties-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Property holder for query properties or instance properties

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-property-constraint"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ property-constraint: object
   :name: property-constraint-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

TBD

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM named-query-element (is composed of property-constraint)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 property-constraint-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 constraint-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-property-constraints"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ property-constraints: object
   :name: property-constraints-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-constraint: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `property-constraint <#/definitions/property-constraint>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-pserver" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ pserver: object
   :name: pserver-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Compute host whose hostname must be unique and must exactly match what
is sent as a relationship to a vserver.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2One)
-  TO cloud-region (Many2One)
-  TO availability-zone (Many2One)
-  TO lag-interface (comprises pserver, Many2Many)
-  TO p-interface (comprises pserver, Many2Many)
-  TO zone (Many2One)
-  FROM generic-vnf
-  FROM group-assignment
-  FROM vserver
-  FROM logical-link

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 hostname: string
    Value from executing hostname on the compute node.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ptnii-equip-name: string
    PTNII name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 number-of-cpus: integer
    Number of cpus

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 disk-in-gigabytes: integer
    Disk size, in GBs

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ram-in-megabytes: integer
    RAM size, in MBs

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-type: string
    Equipment type. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-vendor: string
    Equipment vendor. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equip-model: string
    Equipment model. Source of truth should define valid values.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 fqdn: string
    Fully-qualified domain name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pserver-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-address: string
    Used to configure device, also used for troubleshooting and is IP
    used for traps generated by device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 serial-number: string
    Serial number, may be queried

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-loopback-0: string
    IPV4 Loopback 0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-loopback-0: string
    IPV6 Loopback 0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-aim: string
    IPV4 AIM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-aim: string
    IPV6 AIM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-oam: string
    IPV6 OAM address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 inv-status: string
    CANOPI's inventory status. Only set with values exactly as defined
    by CANOPI.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pserver-id: string
    ID of Pserver

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 internet-topology: string
    internet topology of Pserver

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 pserver-name2: string
    alternative pserver name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 purpose: string
    purpose of pserver

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Prov Status of this device (not under canopi control) Valid values
    [PREPROV/NVTPROV/PROV]

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 management-option: string
    Indicates who owns and or manages the device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 host-profile: string
    The host profile that defines the configuration of the pserver.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 p-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `p-interface <#/definitions/p-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lag-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-pservers" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ pservers: object
   :name: pservers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of compute hosts.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 pserver: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `pserver <#/definitions/pserver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-query-parameters" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ query-parameters: object
   :name: query-parameters-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

QueryParameters for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 named-query: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query <#/definitions/named-query>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 overloaded-model: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `overloaded-model <#/definitions/overloaded-model>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-related-lookup" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ related-lookup: object
   :name: related-lookup-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

TBD

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM named-query-element (is composed of related-lookup)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 related-lookup-uuid: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 source-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 source-node-property: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 target-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 target-node-property: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-collect-list: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-related-lookups" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ related-lookups: object
   :name: related-lookups-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 related-lookup: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `related-lookup <#/definitions/related-lookup>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-related-to-property"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ related-to-property: object
   :name: related-to-property-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-key: string
    Key part of a key/value pair

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    Value part of a key/value pair

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-relationship" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ relationship: object
   :name: relationship-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 related-to: string
    A keyword provided by A&AI to indicate type of node.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 related-link: string
    URL to the object in A&AI.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-data: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship-data <#/definitions/relationship-data>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 related-to-property: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `related-to-property <#/definitions/related-to-property>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-relationship-data"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ relationship-data: object
   :name: relationship-data-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 relationship-key: string
    A keyword provided by A&AI to indicate an attribute.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-value: string
    Value of the attribute.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-relationship-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ relationship-list: object
   :name: relationship-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 relationship: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-reserved-prop-names"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ reserved-prop-names: object
   :name: reserved-prop-names-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Internal map to define some reserved properties of a vertex

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 last-mod-source-of-truth: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 aai-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 aai-created-ts: integer
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 aai-unique-key: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 aai-last-mod-ts: integer
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 source-of-truth: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 aai-uri: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-response-list" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ response-list: object
   :name: response-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Response container for the results of a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 inventory-response-items: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `inventory-response-items <#/definitions/inventory-response-items>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-result-data" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ result-data: object
   :name: result-data-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 resource-type: string
    The specific type of node in the A&AI graph

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-link: string
    The URL to the specific resource

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-route-table-reference"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ route-table-reference: object
   :name: route-table-reference-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack route table reference.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM l3-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 route-table-reference-id: string
    Route Table Reference id, UUID assigned to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 route-table-reference-fqdn: string
    FQDN entry in the route table.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-route-table-references"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ route-table-references: object
   :name: route-table-references-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack route table references

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 route-table-reference: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `route-table-reference <#/definitions/route-table-reference>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-route-target" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ route-target: object
   :name: route-target-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Route target information

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM vpn-binding (is composed of route-target)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 global-route-target: string
    Number used to identify an RT, globally unique in the network

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 route-target-role: string
    Role assigned to this route target

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-route-targets" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ route-targets: object
   :name: route-targets-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of route target information

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 route-target: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `route-target <#/definitions/route-target>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-routing-instance" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ routing-instance: object
   :name: routing-instance-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  TO site-pair (comprises routing-instance, Many2Many)
-  FROM site-pair-set (is composed of routing-instance)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 routing-instance-id: string
    Unique id of routing instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 rpm-owner: string
    rpm owner

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 site-pairs: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `site-pair <#/definitions/site-pair>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-routing-instances"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ routing-instances: object
   :name: routing-instances-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

set of probes related to generic-vnf routing instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 routing-instance: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `routing-instance <#/definitions/routing-instance>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-sdn-zone-response"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ sdn-zone-response: object
   :name: sdn-zone-response-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 oam-networks: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `oam-networks <#/definitions/oam-networks>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 az-and-dvs-switches: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `az-and-dvs-switches <#/definitions/az-and-dvs-switches>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-search" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ search: object
   :name: search-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 edge-tag-query-result: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `edge-tag-query-result <#/definitions/edge-tag-query-result>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 edge-tag-query-request: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `edge-tag-query-request <#/definitions/edge-tag-query-request>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 search-results: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `search-results <#/definitions/search-results>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 sdn-zone-response: object
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `sdn-zone-response <#/definitions/sdn-zone-response>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-search-results" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ search-results: object
   :name: search-results-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 result-data: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `result-data <#/definitions/result-data>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-secondary-filt" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ secondary-filt: object
   :name: secondary-filt-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

SecondaryFilt for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-secondary-filter" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ secondary-filter: object
   :name: secondary-filter-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 filter-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-secondary-filts" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ secondary-filts: object
   :name: secondary-filts-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

SecondaryFilts for performing a named-query or model query

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 secondary-filt: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `secondary-filt <#/definitions/secondary-filt>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-segmentation-assignment"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ segmentation-assignment: object
   :name: segmentation-assignment-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack segmentation assignment.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM l3-network (is composed of segmentation-assignment)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 segmentation-id: string
    Route Table Reference id, UUID assigned to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-segmentation-assignments"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ segmentation-assignments: object
   :name: segmentation-assignments-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack segmentation assignments

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 segmentation-assignment: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `segmentation-assignment <#/definitions/segmentation-assignment>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service: object
   :name: service-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Stand-in for service model definitions. Likely to be deprecated in favor
of models from ASDC. Does not strictly map to ASDC services.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-id: string
    This gets defined by others to provide a unique ID for the service,
    we accept what is sent.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-description: string
    Description of the service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-version: string
    service version

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-capabilities"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-capabilities: object
   :name: service-capabilities-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of service capabilities.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-capability: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-capability <#/definitions/service-capability>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-capability"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-capability: object
   :name: service-capability-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Early definition of server/resource pairings, likely to be replaced by
models. No new use should be made of this.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM availability-zone
-  FROM oam-network

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-type: string
    This gets defined by others to provide a unique ID for the service,
    we accept what is sent.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-type: string
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-design-and-creation"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-design-and-creation: object
   :name: service-design-and-creation-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Namespace for objects managed by ASDC

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-images: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vnf-image <#/definitions/vnf-image>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 services: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service <#/definitions/service>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 service-capabilities: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-capability <#/definitions/service-capability>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 models: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `model <#/definitions/model>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 named-queries: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `named-query <#/definitions/named-query>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-instance" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-instance: object
   :name: service-instance-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Instance of a service

.. rubric:: Related Nodes
   :name: related-nodes

-  TO configuration (One2Many)
-  TO zone (Many2One)
-  TO cvlan-tag (Many2Many)
-  TO pnf (One2Many)
-  TO connector (Many2Many)
-  TO metadatum (comprises service-instance, Many2Many)
-  TO logical-link (Many2Many)
-  TO vlan (One2Many)
-  TO service-instance (One2Many)
-  TO ctag-assignment (One2Many)
-  TO instance-group (Many2Many)
-  TO allotted-resource (comprises service-instance, Many2Many)
-  TO allotted-resource (Many2Many)
-  FROM generic-vnf
-  FROM l3-network
-  FROM owning-entity
-  FROM project
-  FROM service-subscription (is composed of service-instance)
-  FROM vce
-  FROM service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-instance-id: string
    Uniquely identifies this instance of a service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-instance-name: string
    This field will store a name assigned to the service-instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-type: string
    String capturing type of service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-role: string
    String capturing the service role.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 environment-context: string
    This field will store the environment context assigned to the
    service-instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 workload-context: string
    This field will store the workload context assigned to the
    service-instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-total: string
    Indicates the total bandwidth to be used for this service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-up-wan1: string
    indicates the upstream bandwidth this service will use on the WAN1
    port of the physical device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-down-wan1: string
    indicates the downstream bandwidth this service will use on the WAN1
    port of the physical device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-up-wan2: string
    indicates the upstream bandwidth this service will use on the WAN2
    port of the physical device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-down-wan2: string
    indicates the downstream bandwidth this service will use on the WAN2
    port of the physical device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vhn-portal-url: string
    URL customers will use to access the vHN Portal.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-instance-location-id: string
    An identifier that customers assign to the location where this
    service is being used.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    Path to the controller object.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 metadata: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `metadatum <#/definitions/metadatum>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 allotted-resources: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `allotted-resource <#/definitions/allotted-resource>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-instances"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-instances: object
   :name: service-instances-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of service instances

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-instance: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-instance <#/definitions/service-instance>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-subscription"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-subscription: object
   :name: service-subscription-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Object that group service instances.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO service-instance (comprises service-subscription, Many2Many)
-  FROM customer (is composed of service-subscription)
-  FROM tenant

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-type: string
    Value defined by orchestration to identify this service across
    ECOMP.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 temp-ub-sub-account-id: string
    This property will be deleted from A&AI in the near future. Only
    stop gap solution.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-instances: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-instance <#/definitions/service-instance>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-service-subscriptions"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ service-subscriptions: object
   :name: service-subscriptions-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of objects that group service instances.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service-subscription: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service-subscription <#/definitions/service-subscription>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-services" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ services: object
   :name: services-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of service model definitions. Likely to be deprecated in
favor of models from ASDC.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 service: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `service <#/definitions/service>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-site-pair" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ site-pair: object
   :name: site-pair-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  TO class-of-service (comprises site-pair, Many2Many)
-  FROM routing-instance (is composed of site-pair)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 site-pair-id: string
    unique identifier of probe

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 source-ip: string
    Prefix address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 destination-ip: string
    Prefix address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ip-version: string
    ip version, v4, v6

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 destination-hostname: string
    Hostname of the destination equipment to which SLAs are measured
    against.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 destination-equip-type: string
    The type of destinatination equipment. Could be Router, UCPE, etc.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 classes-of-service: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `class-of-service <#/definitions/class-of-service>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-site-pair-set" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ site-pair-set: object
   :name: site-pair-set-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Set of instances for probes used to measure service level agreements

.. rubric:: Related Nodes
   :name: related-nodes

-  TO routing-instance (comprises site-pair-set, Many2Many)
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 site-pair-set-id: string
    Unique id of site pair set.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 routing-instances: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `routing-instance <#/definitions/routing-instance>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-site-pair-sets" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ site-pair-sets: object
   :name: site-pair-sets-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of sets of instances for probes related to generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 site-pair-set: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `site-pair-set <#/definitions/site-pair-set>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-site-pairs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ site-pairs: object
   :name: site-pairs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

probe within a set

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 site-pair: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `site-pair <#/definitions/site-pair>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-snapshot" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ snapshot: object
   :name: snapshot-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack snapshot

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM cloud-region (is composed of snapshot)
-  FROM vserver

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 snapshot-id: string
    Snapshot id, this is the key UUID assoc associated in glance with
    the snapshots.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 snapshot-name: string
    Snapshot name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 snapshot-architecture: string
    Operating system architecture

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 snapshot-os-distro: string
    The common name of the operating system distribution in lowercase

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 snapshot-os-version: string
    The operating system version as specified by the distributor.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application: string
    The application that the image instantiates.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-vendor: string
    The vendor of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-version: string
    The version of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 snapshot-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prev-snapshot-id: string
    This field contains the UUID of the previous snapshot (if any).

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-snapshots" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ snapshots: object
   :name: snapshots-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack snapshots

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 snapshot: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `snapshot <#/definitions/snapshot>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-sriov-pf" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ sriov-pf: object
   :name: sriov-pf-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

SR-IOV Physical Function

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM p-interface (is composed of sriov-pf)
-  FROM sriov-vf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 pf-pci-id: string
    Identifier for the sriov-pf

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-sriov-pfs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ sriov-pfs: object
   :name: sriov-pfs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of SR-IOV Physical Functions.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 sriov-pf: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `sriov-pf <#/definitions/sriov-pf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-sriov-vf" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ sriov-vf: object
   :name: sriov-vf-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

SR-IOV Virtual Function (not to be confused with virtual network
function)

.. rubric:: Related Nodes
   :name: related-nodes

-  TO sriov-pf (Many2One)
-  FROM l-interface (is composed of sriov-vf)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 pci-id: string
    PCI ID used to identify the sriov-vf

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-vlan-filter: string
    This metadata provides option to specify list of VLAN filters
    applied on VF to pass the traffic to VM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-mac-filter: string
    When MAC filters are specified, VF-agent service configures VFs to
    do MAC level filtering before the traffic is passed to VM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-vlan-strip: boolean
    When this field is set to true, VF will configured to strip the
    outer TAG before the traffic is passed to VM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-vlan-anti-spoof-check: boolean
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-mac-anti-spoof-check: boolean
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-mirrors: string
    This option defines the set of Mirror objects which essentially
    mirrors the traffic from source to set of collector VNF Ports.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-broadcast-allow: boolean
    This option, if set to true, sets the VF in promiscuous mode and
    allows all broadcast traffic to reach the VM

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-unknown-multicast-allow: boolean
    This option, if set to true, sets the VF in promiscuous mode and
    allows unknown multicast traffic to reach the VM

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-unknown-unicast-allow: boolean
    This option, if set to true, sets the VF in promiscuous mode and
    allows unknown unicast traffic to reach the VM

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-insert-stag: boolean
    This option, if set to true, instructs to insert outer tag after
    traffic comes out of VM.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-link-status: string
    This option is used to set the link status. Valid values as of 1607
    are on, off, and auto.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of the interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-sriov-vfs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ sriov-vfs: object
   :name: sriov-vfs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of SR-IOV Virtual Functions.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 sriov-vf: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `sriov-vf <#/definitions/sriov-vf>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-start-node-filter"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ start-node-filter: object
   :name: start-node-filter-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 property-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 property-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-subnet" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ subnet: object
   :name: subnet-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  TO host-route (comprises subnet, One2Many)
-  FROM l3-interface-ipv4-address-list
-  FROM l3-interface-ipv6-address-list
-  FROM l3-network (is composed of subnet)
-  FROM vip-ipv4-address-list
-  FROM vip-ipv6-address-list

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 subnet-id: string
    Subnet ID, should be UUID.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subnet-name: string
    Name associated with the subnet.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-subnet-id: string
    Neutron id of this subnet

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 gateway-address: string
    gateway ip address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 network-start-address: string
    network start address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 cidr-mask: string
    cidr mask

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ip-version: string
    ip version

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dhcp-enabled: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dhcp-start: string
    the start address reserved for use by dhcp

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 dhcp-end: string
    the last address reserved for use by dhcp

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subnet-role: string
    role of the subnet, referenced when assigning IPs

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ip-assignment-direction: string
    ip address assignment direction of the subnet

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 subnet-sequence: integer
    sequence of the subnet

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 host-routes: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `host-route <#/definitions/host-route>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-subnets" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ subnets: object
   :name: subnets-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 subnet: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `subnet <#/definitions/subnet>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-tagged-inventory-item-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ tagged-inventory-item-list: object
   :name: tagged-inventory-item-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 inventory-item: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `inventory-item <#/definitions/inventory-item>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-tenant" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ tenant: object
   :name: tenant-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Openstack tenant

.. rubric:: Related Nodes
   :name: related-nodes

-  TO l3-network (Many2Many)
-  TO service-subscription (Many2Many)
-  TO vserver (comprises tenant, One2Many)
-  FROM cloud-region (is composed of tenant)
-  FROM group-assignment
-  FROM volume-group

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 tenant-id: string
    Unique id relative to the cloud-region.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 tenant-name: string
    Readable name of tenant

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 tenant-context: string
    This field will store the tenant context.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vservers: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vserver <#/definitions/vserver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-tenants" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ tenants: object
   :name: tenants-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of openstack tenants.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 tenant: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `tenant <#/definitions/tenant>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-tunnel-xconnect" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ tunnel-xconnect: object
   :name: tunnel-xconnect-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Represents the specifics of a tunnel cross connect piece of a resource
that gets separately allotted

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM allotted-resource (is composed of tunnel-xconnect)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 id: string
    Allotted Resource id UUID assigned to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-up-wan1: string
    The WAN uplink bandwidth for WAN1

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-down-wan1: string
    The WAN downlink bandwidth for WAN1

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-up-wan2: string
    The WAN uplink bandwidth for WAN2

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 bandwidth-down-wan2: string
    The WAN downlink bandwidth for WAN2

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-tunnel-xconnects" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ tunnel-xconnects: object
   :name: tunnel-xconnects-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

This object is used to store the specific tunnel cross connect aspects
of an allotted resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 tunnel-xconnect: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `tunnel-xconnect <#/definitions/tunnel-xconnect>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-update" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ update: object
   :name: update-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Serves a PATCH like function. Does not enforce concurrency control.
Clear each usage with AAI team.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 update-node-type: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 update-node-uri: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 update-node-key: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `update-node-key <#/definitions/update-node-key>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 action: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `action <#/definitions/action>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-update-node-key" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ update-node-key: object
   :name: update-node-key-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 key-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 key-value: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vce" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vce: object
   :name: vce-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Virtual Customer Edge Router, used specifically for Gamma. This object
is deprecated.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO availability-zone (Many2Many)
-  TO complex (Many2Many)
-  TO port-group (comprises vce, Many2Many)
-  TO vserver (Many2Many)
-  TO service-instance (Many2Many)
-  TO entitlement (comprises vce, One2Many)
-  TO license (comprises vce, One2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-id: string
    Unique id of VNF. This is unique across the graph.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name: string
    Name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-name2: string
    Alternate name of VNF.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-type: string
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 service-id: string
    Unique identifier of service, does not strictly map to ASDC
    services, SOON TO BE DEPRECATED.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 regional-resource-zone: string
    Regional way of organizing pservers, source of truth should define
    values

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this resource by Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 operational-status: string
    Indicator for whether the resource is considered operational

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 license-key: string
    OBSOLETE - do not use

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equipment-role: string
    Network role being played by this VNF

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance, managed by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 mso-catalog-key: string
    Corresponds to the SDN-C catalog id used to configure this VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpe-id: string
    Unique ID of VPE connected to this VCE.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 v6-vce-wan-address: string
    Valid v6 IP address for the WAN Link on this router. Implied length
    of /64.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-address: string
    Address tail-f uses to configure vce, also used for troubleshooting
    and is IP used for traps generated by VCE.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-loopback0-address: string
    Loopback0 address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 entitlement-resource-uuid: string
    OBSOLETE - see child relationships

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 port-groups: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `port-group <#/definitions/port-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 licenses: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `license <#/definitions/license>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 entitlements: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `entitlement <#/definitions/entitlement>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vces" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vces: object
   :name: vces-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of Virtual Customer Edge Routers, used specifically for
Gamma. This object is deprecated.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vce: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vce <#/definitions/vce>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vf-module" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vf-module: object
   :name: vf-module-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

a deployment unit of VNFCs

.. rubric:: Related Nodes
   :name: related-nodes

-  TO volume-group (One2One)
-  TO l3-network (Many2Many)
-  TO vnfc (One2Many)
-  FROM vserver
-  FROM generic-vnf (is composed of vf-module)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vf-module-id: string
    Unique ID of vf-module.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-module-name: string
    Name of vf-module

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this instance.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    orchestration status of this vf-module, mastered by MSO

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-base-vf-module: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 persona-model-version: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-customization-id: string
    captures the id of all the configuration used to customize the
    resource for the service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-id: string
    the ASDC data dictionary widget model. This maps directly to the
    A&AI widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 widget-model-version: string
    the ASDC data dictionary version of the widget model.This maps
    directly to the A&AI version of the widget.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 contrail-service-instance-fqdn: string
    the Contrail unique ID for a service-instance

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 module-index: integer
    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

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    Path to the controller object.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vf-modules" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vf-modules: object
   :name: vf-modules-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of vf-modules, a deployment unit of VNFCs

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vf-module: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vf-module <#/definitions/vf-module>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vig-server" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vig-server: object
   :name: vig-server-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

vig-server contains information about a vig server used for
IPSec-configuration. Populated by SDN-C from 1607

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM ipsec-configuration (is composed of vig-server)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vig-address-type: string
    indicates whether the VIG is for AVPN or INTERNET

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-vig: string
    v4 IP of the vig server

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v6-vig: string
    v6 IP of the vig server

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vig-servers" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vig-servers: object
   :name: vig-servers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 vig-server: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vig-server <#/definitions/vig-server>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vip-ipv4-address-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vip-ipv4-address-list: object
   :name: vip-ipv4-address-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

IPv4 Address Range

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO subnet (Many2Many)
-  FROM vnfc
-  FROM cloud-region (is composed of vip-ipv4-address-list)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vip-ipv4-address: string
    IP address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vip-ipv4-prefix-length: integer
    Prefix length, 32 for single address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-inner: integer
    Inner VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Outer VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-floating: boolean
    Indicator of fixed or floating address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of the interface that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-subnet-id: string
    Neutron id of subnet that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vip-ipv6-address-list"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vip-ipv6-address-list: object
   :name: vip-ipv6-address-list-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

IPv6 Address Range

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO subnet (Many2Many)
-  FROM vnfc
-  FROM cloud-region (is composed of vip-ipv6-address-list)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vip-ipv6-address: string
    IP address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vip-ipv6-prefix-length: integer
    Prefix length, 128 for single address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-inner: integer
    Inner VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Outer VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-floating: boolean
    Indicator of fixed or floating address

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-network-id: string
    Neutron network id of the interface that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 neutron-subnet-id: string
    Neutron id of subnet that address belongs to

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-virtual-data-center"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ virtual-data-center: object
   :name: virtual-data-center-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Virtual organization of cloud infrastructure elements in a data center
context

.. rubric:: Related Nodes
   :name: related-nodes

-  TO generic-vnf (Many2Many)
-  TO logical-link (Many2Many)
-  FROM connector

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vdc-id: string
    Unique ID of the vdc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vdc-name: string
    Name of the virtual data center

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-virtual-data-centers"
   class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ virtual-data-centers: object
   :name: virtual-data-centers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Virtual organization of cloud infrastructure elements in a data center
context

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 virtual-data-center: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `virtual-data-center <#/definitions/virtual-data-center>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vlan" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vlan: object
   :name: vlan-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Definition of vlan

.. rubric:: Related Nodes
   :name: related-nodes

-  TO l3-interface-ipv4-address-list (comprises vlan, Many2Many)
-  TO l3-interface-ipv6-address-list (comprises vlan, Many2Many)
-  TO multicast-configuration (Many2Many)
-  TO logical-link (Many2Many)
-  FROM l-interface (is composed of vlan)
-  FROM service-instance
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vlan-interface: string
    String that identifies the interface

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-inner: integer
    Inner VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Outer VLAN tag

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-value: string
    Captures the numeric part of the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 speed-units: string
    Captures the units corresponding to the speed

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-description: string
    Used to describe (the service associated with) the vlan

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 backdoor-connection: string
    Whether customer is going to use this VLAN for backdoor connection
    to another customer premise device.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpn-key: string
    This indicates the customers VPN ID associated with this vlan

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Status of a vnf's vlan interface, on which the customer circuit
    resides, mastered by SDN-C.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Prov Status of the VLAN configuration related to a logical
    interface. Valid values [PREPROV/NVTPROV/PROV].

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-ip-unnumbered: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv4-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv6-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vlans" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vlans: object
   :name: vlans-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 vlan: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vlan <#/definitions/vlan>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vnf" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vnf: object
   :name: vnf-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Abstract vnf class

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-id: string
    Unique id of VNF. This is unique across the graph.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vnf-image" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vnf-image: object
   :name: vnf-image-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Image object that pertain to a VNF that doesn't have associated
vservers. This is a kludge.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-image-uuid: string
    Unique ID of this asset

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application: string
    The application that the image instantiates.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-vendor: string
    The vendor of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 application-version: string
    The version of the application.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vnf-images" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vnf-images: object
   :name: vnf-images-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of image objects that pertain to a VNF that doesn't have
associated vservers. This is a kludge.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnf-image: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vnf-image <#/definitions/vnf-image>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vnfc" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vnfc: object
   :name: vnfc-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

.. rubric:: Related Nodes
   :name: related-nodes

-  TO instance-group (Many2Many)
-  TO vip-ipv4-address-list (Many2Many)
-  TO vip-ipv6-address-list (Many2Many)
-  FROM vserver
-  FROM vf-module
-  FROM generic-vnf
-  FROM l3-interface-ipv4-address-list (comprises vnfc)
-  FROM l3-interface-ipv6-address-list (comprises vnfc)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnfc-name: string
    Unique ID of vnfc.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nfc-naming-code: string
    Short code that is used in naming instances of the item being
    modeled

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 nfc-function: string
    English description of function that the specific resource
    deployment is providing. Assigned as part of the customization of a
    resource in a service

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    prov status of this vnfc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this VNF, mastered by APP-C

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipaddress-v4-oam-vip: string
    Oam V4 vip address of this vnfc

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-closed-loop-disabled: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 group-notation: string
    Group notation of VNFC

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-invariant-id: string
    the ASDC model id for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-version-id: string
    the ASDC model version for this resource or service model.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv4-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv4-address-list <#/definitions/l3-interface-ipv4-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l3-interface-ipv6-address-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">


    `l3-interface-ipv6-address-list <#/definitions/l3-interface-ipv6-address-list>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vnfcs" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vnfcs: object
   :name: vnfcs-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

virtual network components associated with a vserver from application
controller.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vnfc: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vnfc <#/definitions/vnfc>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-volume" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ volume: object
   :name: volume-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Ephemeral Block storage volume.

.. rubric:: Related Nodes
   :name: related-nodes

-  FROM vserver (is composed of volume)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 volume-id: string
    Unique ID of block storage volume relative to the vserver.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 volume-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-volume-group" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ volume-group: object
   :name: volume-group-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Persistent block-level storage.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2Many)
-  TO tenant (Many2Many)
-  FROM cloud-region (is composed of volume-group)
-  FROM vf-module
-  FROM generic-vnf

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 volume-group-id: string
    Unique ID of volume-group.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 volume-group-name: string
    Name of the volume group.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 heat-stack-id: string
    Heat stack id corresponding to this volume-group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vnf-type: string
    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.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 orchestration-status: string
    Orchestration status of this volume-group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 model-customization-id: string
    captures the id of all the configuration used to customize the
    resource for the service.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vf-module-model-customization-id: string
    helps relate the volume group to the vf-module whose components will
    require the volume group

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-volume-groups" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ volume-groups: object
   :name: volume-groups-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of persistent block-level storage.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 volume-group: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `volume-group <#/definitions/volume-group>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-volumes" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ volumes: object
   :name: volumes-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of ephemeral Block storage volumes.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 volume: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `volume <#/definitions/volume>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vpls-pe" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vpls-pe: object
   :name: vpls-pe-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

VPLS Provider Edge routers.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2Many)
-  TO ctag-pool (Many2Many)
-  TO p-interface (comprises vpls-pe, Many2Many)
-  TO lag-interface (comprises vpls-pe, Many2Many)

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 equipment-name: string
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this VNF by BAU Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 ipv4-oam-address: string
    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).

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 equipment-role: string
    Client should send valid enumerated value, e.g., VPLS-PE.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vlan-id-outer: integer
    Temporary location for stag to get to VCE

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 p-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `p-interface <#/definitions/p-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 lag-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `lag-interface <#/definitions/lag-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vpls-pes" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vpls-pes: object
   :name: vpls-pes-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of VPLS Provider Edge routers

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vpls-pe: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vpls-pe <#/definitions/vpls-pe>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vpn-binding" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vpn-binding: object
   :name: vpn-binding-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

VPN binding

.. rubric:: Related Nodes
   :name: related-nodes

-  TO route-target (comprises vpn-binding, One2Many)
-  FROM l3-network
-  FROM logical-link
-  FROM allotted-resource

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vpn-id: string
    VPN ID, globally unique within A&AI

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpn-name: string
    VPN Name

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpn-platform: string
    the platform associated with the VPN example AVPN, Mobility

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpn-type: string
    Type of the vpn, should be taken from enumerated/valid values

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vpn-region: string
    region of customer vpn

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 customer-vpn-id: string
    id for this customer vpn

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 route-distinguisher: string
    Used to distinguish the distinct VPN routes of separate customers
    who connect to the provider in an MPLS network.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 route-targets: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `route-target <#/definitions/route-target>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vpn-bindings" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vpn-bindings: object
   :name: vpn-bindings-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-properties">

 vpn-binding: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vpn-binding <#/definitions/vpn-binding>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vserver" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vserver: object
   :name: vserver-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Virtual Servers, aka virtual machine or VM.

.. rubric:: Related Nodes
   :name: related-nodes

-  TO flavor (Many2One)
-  TO image (Many2One)
-  TO l-interface (comprises vserver, Many2Many)
-  TO pserver (Many2One)
-  TO volume (comprises vserver, Many2Many)
-  TO vnfc (Many2Many)
-  TO snapshot (One2One)
-  TO vf-module (Many2One)
-  FROM generic-vnf
-  FROM tenant (is composed of vserver)
-  FROM vce

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vserver-id: string
    Unique identifier for this vserver relative to its tenant

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vserver-name: string
    Name of vserver

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vserver-name2: string
    Alternative name of vserver

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 prov-status: string
    Trigger for operational monitoring of this resource by Service
    Assurance systems.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 vserver-selflink: string
    URL to endpoint where AAI can get more details

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 in-maint: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 is-closed-loop-disabled: boolean
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Used for optimistic concurrency. Must be empty on create, valid on
    update and delete.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 volumes: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `volume <#/definitions/volume>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

 l-interfaces: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `l-interface <#/definitions/l-interface>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-vservers" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ vservers: object
   :name: vservers-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of virtual Servers, aka virtual machines or VMs.

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 vserver: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `vserver <#/definitions/vserver>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-zone" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ zone: object
   :name: zone-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

A zone is a grouping of assets in a location homing to the same
connections into the CBB

.. rubric:: Related Nodes
   :name: related-nodes

-  TO complex (Many2One)
-  FROM cloud-region
-  FROM pserver
-  FROM pnf
-  FROM service-instance

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 zone-id: string
    Code assigned by AIC to the zone

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 zone-name: string
    English name associated with the zone

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 design-type: string
    Design of zone [Medium/Large?]

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 zone-context: string
    Context of zone [production/test]

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 status: string
    Status of a zone.

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 resource-version: string
    Concurrency value

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

 relationship-list: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `relationship <#/definitions/relationship>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   <div id="definition-zones" class="panel panel-definition">

.. raw:: html

   <div class="panel-heading">

.. rubric:: ` <>`__\ zones: object
   :name: zones-object
   :class: panel-title

.. raw:: html

   </div>

.. raw:: html

   <div class="panel-body">

.. raw:: html

   <div class="section json-schema-description">

Collection of zones

.. raw:: html

   </div>

.. raw:: html

   <div class="section json-schema-properties">

 zone: object[]
    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       <div class="section json-schema-array-items">

     `zone <#/definitions/zone>`__

    .. raw:: html

       <div class="json-inner-schema">

    .. raw:: html

       </div>

    .. raw:: html

       </div>

    .. raw:: html

       </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>

.. raw:: html

   </div>